Repository navigation
📝 Fix broken installation links in README - #1982
Closed
HyperionBurn wants to merge 1 commit into
Closed
HyperionBurn wants to merge 1 commit into
HyperionBurn wants to merge 1 commit into
Conversation
Both relative links resolved against the repository root, where there is no tutorial/ directory, so they 404. The install guide actually lives at docs/tutorial/install.md. The anchor already matches the heading there, ## Activate the Virtual Environment.
Contributor
📝 Docs previewLast commit 6fce814 at: https://36ea93f3.typertiangolo.pages.dev |
Member
|
Thanks for pointing to this, but it should be solved differently. It's been already reported in #1862 (comment). We will fix it later. Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two relative links in
README.mdpoint attutorial/install.md. Relative links in a repository-root README resolve against the repository root, and there is notutorial/directory there, so both of these 404:README.md:57—[activate the project environment and install completion](tutorial/install.md#activate-the-virtual-environment)README.md:59—[installation guide](tutorial/install.md)The install guide lives at
docs/tutorial/install.md, so this prefixes both targets withdocs/.These are the only two
.mdlinks in the file; every other link is an absolute URL.How this was verified
Checked against
master(a5882de):There is no
tutorial/entry at the repository root;docs/tutorial/install.mddoes exist.Resolving both links against GitHub:
The anchor needs no change.
docs/tutorial/install.md:38is## Activate the Virtual Environment, which slugifies toactivate-the-virtual-environment, exactly what the link already asks for.Both links are ordinary prose paragraphs, not inside a fenced code block or an HTML comment, so they are rendered links on the repository front page.
README.mdis not part of the documentation site —mkdocs.ymlbuilds the nav fromdocs/index.mdonward — so these links are intended for GitHub itself, where they were broken.Checked that no open issue or PR already covers it.
Two lines changed.