Skip to content

[DOCS, I18N] Establish multilingual glossary and translation workflow baseline #60

@bnbong

Description

@bnbong

Requesting other issue

Create the shared glossary and translation workflow baseline for documentation localization.

Why

Before translating multiple locales in parallel, FastAPI-fastkit needs a stable terminology baseline so key technical terms are translated consistently across Korean, Japanese, Chinese, Spanish, French, and German docs.

Scope

  • Define canonical handling rules for:
    • product names
    • CLI commands
    • code blocks
    • file paths
    • env vars
    • template names
  • Add or update a glossary section in the translation docs
  • Standardize the core English source terms that later batches must follow
  • Add reviewer guidance for translation PRs

Required source terms

At minimum, define handling guidance for:

  • starter
  • template
  • architecture preset
  • source of truth
  • fallback / fallback to English
  • domain-oriented
  • layered
  • router
  • service
  • repository
  • generated project
  • manual wiring
  • health endpoint
  • quick start
  • user guide

Non-Goals

  • Translating all locale pages in this issue
  • Rewriting the English source docs
  • Adding new product features

Acceptance Criteria

  • Translation docs contain a glossary or equivalent canonical term table
  • Translation workflow rules are explicit and reusable
  • The glossary is ready to be referenced by all locale rollout issues
  • uv run mkdocs build passes

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions