Skip to content

Link to README.md instead of referring to below in INSTALL.md #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

cafce25
Copy link
Contributor

@cafce25 cafce25 commented Mar 30, 2025

Fix the misleading references to below in INSTALL.md.

Took me a while to figure out "below" really meant "in README.md".

Fix the misleading references to below in `INSTALL.md`.
@twistedfall twistedfall requested a review from Copilot March 30, 2025 15:04
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes misleading references in INSTALL.md by replacing the ambiguous "see below" with an explicit link to the Environment Variables section of README.md.

  • Updated the reference for environment variables in the installation steps.
  • Ensured consistent linking to README.md across multiple sections.

@twistedfall twistedfall merged commit f4412f7 into twistedfall:master Mar 30, 2025
18 checks passed
@twistedfall
Copy link
Owner

Thanks a lot! This is the fallout from when I split the README into several smaller parts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants