馃摑 Tweak docs and translations links, typos, format #11389
Merged
Conversation
This file contains 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
The affected files are `index.md`, `features.md`, `fastapi-people.md`, under `docs/<lang>/docs/`. The changes are all the same.
The affected files are `docs/<langname>/docs/index.md`. All the same changes.
Has no effect regarding the link target, but syncs the syntax with other links in the docs.
Like previous commit.
Like previous commit.
Like previous commit.
My linkchecker script suggested them. I also compared the link target of the translation and the related English target side by side, to check that translated hash is correct.
Also translated the link text in tutorial/first-steps.md, according to the related target heading.
Also translated the link text in tutorial/first-steps.md, according to the related target heading.
Like previous commits.
Like previous commits.
Like previous commits.
Like previous commits.
The target heading changed in the English docs. The linkchecker script also reported these, and I checked manually.
Like previous commit.
Invalid hashes added in translations. Also reported by the linkchecker and manually tested.
This is automatically done by Mkdocs, so these manual anchors are not needed.
The same hash is also used in other occurences of that link.
Other local links under advanced/ also have that syntax. The link may now also automatically point to the translated page.
Like in other locations.
It's JavaScript, not Python.
The target code file has changed.
These boxes are often misunderstood in translations. I also did translate the keywords in the beginning. The syntax is "!!! " followed by <keyword>, optionally followed by " " <translation> <keyword> is required and is one of "info|note|tip|check|warning|danger". It defines the coloring of the info box. When it was missing, I added it, checking the related English .md. <translation> may come after <keyword> and is inside of "". If the translation was available, I added it. A global search under docs/ in VS Code with the regex "!!! (?!tip|warning|info|danger|note|check)" shows info boxes which do not comply to this scheme. I left the invalid boxes under docs/fa/unchanged, because this is a right to left language and I am unsure how to write it there.
Brings them in sync with the rest of the documentation, where the paragraphs are one big line.
|
馃摑 Docs preview for commit beef2fb at: https://d1be5c2a.fastapitiangolo.pages.dev |
|
馃摑 Docs preview for commit f502f51 at: https://063f9634.fastapitiangolo.pages.dev |
tiangolo
changed the title
|
馃摑 Docs preview for commit e613636 at: https://9fc802bb.fastapitiangolo.pages.dev |
|
Nice, thank you @nilslindemann! 馃殌 馃嵃 |
|
Dito @tiangolo, thank you. |
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.
Regeneration of #10985 minus ambiguous changes, which I outsource to #11390. It should now be easier to review. All changes here are unambiguous improvements.