Summary
The documentation site (https://fastapi-cachex.readthedocs.io/en/latest/) has been English-only since #85. docs/README.zh-TW.md still exists for GitHub readers, but it is not in the site navigation, and it predates the #85 corrections.
Read the Docs serves translations as separate projects linked to the main one. The result is /zh-tw/latest/ with a language switcher on the site.
Decisions
See the decision comment below for details.
- English is the source of truth; the translation may lag. Doc PRs do not need to update both languages. Each Chinese page shows a "may be outdated" notice that links to the English original.
- Scope: the landing page and the user guides.
DEVELOPMENT.md, CONTRIBUTING.md, the CHANGELOG and the API reference stay English-only, and the Chinese nav links to the English pages for them.
- Terminology: Taiwan usage. Code, parameter and header names stay untranslated. A glossary lives at
i18n/zh-TW/GLOSSARY.md.
Tracking
This issue spans several PRs. Each PR references it with Part of #89; only the last one closes it.
PR 1: infrastructure (#146)
Read the Docs setup (maintainer, after PR 1)
PR 2: guides (#147)
PR 3: session guides (closes this issue) (#148)
Summary
The documentation site (https://fastapi-cachex.readthedocs.io/en/latest/) has been English-only since #85.
docs/README.zh-TW.mdstill exists for GitHub readers, but it is not in the site navigation, and it predates the #85 corrections.Read the Docs serves translations as separate projects linked to the main one. The result is
/zh-tw/latest/with a language switcher on the site.Decisions
See the decision comment below for details.
DEVELOPMENT.md,CONTRIBUTING.md, the CHANGELOG and the API reference stay English-only, and the Chinese nav links to the English pages for them.i18n/zh-TW/GLOSSARY.md.Tracking
This issue spans several PRs. Each PR references it with
Part of #89; only the last one closes it.PR 1: infrastructure (#146)
zensical.zh-TW.toml,docs_dir = "i18n/zh-TW/docs",language = "zh-Hant", ownsite_url)docs/, so the English build does not pick them up (Zensical ignoresexclude_docs).readthedocs.yamlfor the Chinese project (i18n/zh-TW/.readthedocs.yaml)docs/README.zh-TW.md; untranslated guides link to the English siteRead the Docs setup (maintainer, after PR 1)
fastapi-cachex-zh-twproject, set its language to Traditional Chinese, and point its build configuration file ati18n/zh-TW/.readthedocs.yaml/zh-tw/latest/builds and that the language switcher worksPR 2: guides (#147)
PR 3: session guides (closes this issue) (#148)