Skip to content

📝 Fix broken installation links in README - #1982

Closed
HyperionBurn wants to merge 1 commit into
fastapi:masterfrom
HyperionBurn:docs/fix-readme-installation-links
Closed

HyperionBurn wants to merge 1 commit into
fastapi:masterfrom
HyperionBurn:docs/fix-readme-installation-links

Conversation

@HyperionBurn

Copy link
Copy Markdown

What

Two relative links in README.md point at tutorial/install.md. Relative links in a repository-root README resolve against the repository root, and there is no tutorial/ 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 with docs/.

These are the only two .md links 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.md does exist.

  • Resolving both links against GitHub:

    404  <-  https://github.com/fastapi/typer/blob/master/tutorial/install.md
    200  <-  https://github.com/fastapi/typer/blob/master/docs/tutorial/install.md
    
  • The anchor needs no change. docs/tutorial/install.md:38 is ## Activate the Virtual Environment, which slugifies to activate-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.md is not part of the documentation site — mkdocs.yml builds the nav from docs/index.md onward — 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.

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.
@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview

Last commit 6fce814 at: https://36ea93f3.typertiangolo.pages.dev

@YuriiMotov

Copy link
Copy Markdown
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!

@YuriiMotov YuriiMotov closed this Oct 19, 2026
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.

3 participants