Docs: Broken link in Contributions.md

[phalberg]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the documentation, with the integrated search.
• I already searched in Google "How to X" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.

Commit to Help

• I commit to help with one of those options 👆

Example Code

"
# Development - Contributing

First, you might want to see the basic ways to [help Typer and get help](help-typer.md).
"
Should (perhaps) be changed to:
"
# Development - Contributing

First, you might want to see the basic ways to [help Typer and get help](/docs/help-typer.md).
"

Description

At the start of the documentation of contributions.md it looks like this (see code block above)
The link (help-typer.md) here is possible to click trough via vs-code or other IDE's, but in Github (on like the frontpage of the repo when you click trough the README, CONTRIBUTIONS, LICENSE) one would stumble into this error (see image below - error). It is trying to go into: https://github.com/fastapi/typer/blob/master/help-typer.md but in fact, if i search trough the project it should rather go to: https://github.com/fastapi/typer/blob/master/docs/help-typer.md. I forked the repo myself and fixed the issue by
going from (help-typer.md) to (/docs/help-typer.md) - but this should also perhaps be done in managment.md (?) but there a relative path is used (i.e ./) which is not the case here regardless.

Operating System

Windows

Operating System Details

No response

Project Version

0.62.2

Python Version

Python 3.13.7

Additional Context

https://github.com/fastapi/typer/blob/master/help-typer.md:

The page is rather at docs:
https://github.com/fastapi/typer/blob/master/docs/help-typer.md

[sueun-dev]

this is real, but it's a GitHub overview-tab edge case.

The normal docs/contributing.md blob page resolves help-typer.md to docs/help-typer.md, and the docs site renders it as ../help-typer/. But the repo overview's Contributing tab renders that same link as /fastapi/typer/blob/master/help-typer.md, so the 404 happens there.

/docs/help-typer.md fixes that GitHub overview render, though I'd still check the generated docs before PRing it because /docs/help-typer.md isn't the live Typer docs URL. The live URL is https://typer.tiangolo.com/help-typer/.

[svlandeg]

Right, yes, there's indeed a 404 when clicking the help-typer link from over at https://github.com/fastapi/typer?tab=contributing-ov-file. We'd be open to correct this as long as all other links/use-cases from the docs etc remain valid.

[phalberg]

Right - okay, I am back.
First of all, thank you for the input @sueun-dev and @svlandeg !

I looked into this a bit more, it seems /docs/ or any alternative of it (i.e ./docs/(...), etc) makes Github render it correctly, but then MkDocs complains about issues, if I understand correctly because it probably parses it as docs/docs/(...) which is faulty.

Now other alternatives make the problem the other way around (basically from Github it gives 404 again because it tries to get to /fastapi/typer/blob/master/help-typer.md like you pointed out @sueun-dev, but then MkDocs has no issues).

The middle-ground I found was using the live page, i.e : https://typer.tiangolo.com/help-typer/ for it to point to, this gives both no issues from MkDocs and the GitHub renders it correctly to the page. Altough this approach uses the live page - which I am not sure is favorable - but i see it is getting used in a lot of other links regardless...
So basically:
(...) [help Typer and get help](https://typer.tiangolo.com/help-typer/)

I also tested this: docs/help-typer.md# which seems to avoid the MkDocs warning while still resolving correctly on GitHub, but that feels more like relying on a validation edge case than a robust solution, so I would not suggest using it.

Some useful links I found along the way:
https://github.com/github/docs/blob/main/data/reusables/repositories/relative-links.md
https://www.mkdocs.org/user-guide/writing-your-docs/#internal-links

Would using the published docs URL be acceptable here? If so, I’m happy to open a PR with that change, unless maintainers prefer to handle it directly.

[svlandeg]

Sure, as you said, we're already using the live URL in several of the links. Thanks!

[svlandeg]

Fix merged in #1826