-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
📝 Cleanup local links in docs #10500
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
Conversation
Some of them may already have been fixed by fastapi#10498 (which actually inspired this PR)
|
📝 Docs preview for commit a70447f at: https://1ef63924.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit ee6dacd at: https://1f18c5a9.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit cffefaf at: https://8c342b91.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 1b6655d at: https://b449584e.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit a2fa82f at: https://ee9a510f.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 325f74d at: https://504d978d.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 7e5b836 at: https://bff0d3dc.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 144f351 at: https://1d0fc264.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 519fbbc at: https://c71024c4.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 1f67fa4 at: https://934240ea.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit ced796f at: https://d1d6f727.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit 9334014 at: https://acfe7c55.fastapitiangolo.pages.dev |
|
📝 Docs preview for commit e1bd7e6 at: https://77e01fba.fastapitiangolo.pages.dev |
(I will recreate this in a later PR)
The PR only touches local links to markdowns (links to .pngs and .pys are all good) and does not touch external links.
Aside of fixing broken local links,
/)index.mdwhere missing, so that all links either are hash-only in-document links or links with.mdin them./from start of linksThe following patterns can be used to search for these links (and should find nothing with this PR applied):
index.md: the regex\]\((?!http)[^)#]*/(#[^#)]+)?\)](/](./I also fix untranslated
#hash-partsin links, so far ines,fr,em. Will add more commits. When the author has not translated the link text, I leave it, instead of guessing.This script tests if all links are according to the above definitions, and it checks if the path parts of links point to existing files. It does not check if the hash points to an existing heading. After this PR is applied, the script outputs: