馃摑 Tweak docs and translations links, typos, format #11389
Commits on Apr 1, 2024
-
Layout: add syntax blocks hiding the navigation
The affected files are `index.md`, `features.md`, `fastapi-people.md`, under `docs/<lang>/docs/`. The changes are all the same.
-
Layout: add style hiding the h1 heading
The affected files are `docs/<langname>/docs/index.md`. All the same changes.
-
-
Links: remove './' (language: em)
Has no effect regarding the link target, but syncs the syntax with other links in the docs.
-
Links: translate #hash parts (language: em)
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.
-
Links: translate #hash parts (language: ja)
Also translated the link text in tutorial/first-steps.md, according to the related target heading.
-
Links: translate #hash parts (language: ko)
Also translated the link text in tutorial/first-steps.md, according to the related target heading.
-
Links: translate #hash parts (language: pt)
Like previous commits.
-
Links: translate #hash parts (language: ru)
Like previous commits.
-
Links: translate #hash parts (language: zh)
Like previous commits.
-
Links: translate #hash parts (other languages)
Like previous commits.
-
Links: fix #hash parts: "experts" -> "fastapi-experts"
The target heading changed in the English docs. The linkchecker script also reported these, and I checked manually.
-
Links: fix #hash parts: "issues" -> "questions"
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.
-
Links: convert html link to md link
Other local links under advanced/ also have that syntax. The link may now also automatically point to the translated page.
-
Code blocks: move annotated before non-annotated
Like in other locations.
-
Code blocks: fix a line highlighting in an example
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.
-
-
-
-
-
-
-
-
Whitespace: remove single line breaks in reference
Brings them in sync with the rest of the documentation, where the paragraphs are one big line.
-
