Skip to content

[EPIC] documentation localization rollout #59

@bnbong

Description

@bnbong

Requesting other issue

Documentation localization rollout for all supported docs locales.

Why

FastAPI-fastkit currently builds documentation for these locales:

  • English (en) - canonical source of truth
  • Korean (ko)
  • Japanese (ja)
  • Chinese (zh)
  • Spanish (es)
  • French (fr)
  • German (de)

The docs site already documents that English is the source of truth and that translated pages may lag behind or fall back to English.

Goals

  • Translate high-value docs across all supported non-English locales
  • Establish a shared multilingual glossary before large-scale translation
  • Land translations in small reviewable batches instead of one large PR
  • Keep terminology consistent across locales and across batches
  • Keep docs/en/ as the canonical source of truth
  • Update translation completeness/status as batches land

Scope

  • Locale rollout for:
    • ko
    • ja
    • zh
    • es
    • fr
    • de
  • Translation workflow and glossary alignment
  • Translation status updates
  • Documentation-only changes

Non-Goals

  • Product/runtime behavior changes
  • Rewriting English docs as part of translation work
  • Shipping all locale work in a single PR
  • Claiming full parity before each locale is actually reviewed

Recommended rollout

  1. Establish glossary and translation workflow baseline
  2. Translate core user-guide pages for each locale
  3. Translate remaining user-guide and tutorial pages
  4. Translate contributing/reference/changelog pages as needed
  5. Update translation status after each landed batch

Release / merge policy

  • English remains the source of truth
  • Each translation PR should stay small and reviewable
  • AI-generated translations require human review before merge
  • Translation status must reflect actual repository state

Acceptance Criteria

  • A glossary/workflow baseline issue is completed
  • Each non-English locale has a tracker issue
  • Translation work lands in multiple small PRs
  • uv run mkdocs build passes for every translation PR
  • Translation status docs remain aligned with the repository state

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions