📝 Add documentation for non-translated pages and scripts to verify them#12020
Merged
Conversation
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
📝 Add documentation for non-translated pages and scripts to verify them
I realized that, for some pages, the benefit of having some translations is less beneficial than having only the original in English, because the original can change frequently, or the content is mainly injected data from external files. In those cases, the actual content translated is small, but the structure and how the data is injected can get obsolete quickly.
Also in the reference, most of the content is injected from the FastAPI source files, so, the translations are only for a small introduction at the top, but the rest of the content stays in English. And if there were new sections in the reference, those would not be visible in the translations, although the content is almost the same, all in English.
This also means that if the sections of injected data change, those translations become obsolete.
There are also sections that are mainly relevant for the internal team, or about how the project is managed, and having the most recent and precise information is more important than having it in multiple languages (that could get behind).