Skip to content

[DOCS] de translation#73

Merged
bnbong merged 1 commit into
mainfrom
dev
May 17, 2026
Merged

[DOCS] de translation#73
bnbong merged 1 commit into
mainfrom
dev

Conversation

@bnbong
Copy link
Copy Markdown
Owner

@bnbong bnbong commented May 17, 2026

Requesting Merging

Description

Part of #59
Refs #60
Closes #66

This PR completes the German documentation localization rollout for FastAPI-fastkit and aligns the related German translation policy/docs with the current localization workflow.

The main goal of this PR is to provide a complete German locale under docs/de/, improve readability and terminology consistency across translated pages, and clarify that the repository-root CHANGELOG.md remains the canonical English release history.

Type of Change

  • BUG FIX
  • ADDING NEW TEMPLATE
  • FEATURE ADDED/UPDATED
  • HOTFIX
  • DELETING UNNECESSARY FEATURES
  • DOCUMENTATION & DEVOPS
  • Etc..

Test Environment

  • Local macOS (Apple Silicon / M1), zsh
  • Python via uv
  • Verified command:
    • uv run mkdocs build
    • Result: Documentation built successfully

Major Changes

  • Completed the German docs locale under docs/de/

    • Added or finalized German pages across:
      • top-level docs pages
      • user-guide pages
      • tutorial pages
      • contributing pages
      • reference pages
    • German locale now has 26 / 26 markdown pages present
  • Improved German readability and terminology consistency

    • Reworked translation-style phrasing into more natural German
    • Standardized visible link labels, explanatory text, code-block comments, and policy wording across all phases
    • Kept commands, product names, template ids, file paths, and env vars in English where appropriate
  • Updated translation policy and status docs

    • Refined the locale rollout guidance to match the current per-locale / phased workflow
    • Clarified English (docs/en/) as the source of truth
    • Updated German translation-status / translation-guide pages to reflect the current localization policy
  • Clarified changelog handling for localized docs

    • Kept the repository-root CHANGELOG.md as the canonical English release history
    • Updated docs/de/changelog.md to act as a German entry point / wrapper for the canonical English changelog instead of maintaining a separate translated release history
    • Adjusted related wording in German policy/reference pages accordingly
  • Refined German docs navigation and cross-page consistency

    • Preserved markdown structure, code fences, tables, admonitions, and internal links
    • Ensured translated pages remain aligned with the English source structure and current MkDocs i18n behavior

Screenshots (optional)

N/A

Etc

  • This PR is documentation-focused and does not change runtime product behavior.

@bnbong bnbong added this to the docs-i18n milestone May 17, 2026
@bnbong bnbong requested a review from Copilot May 17, 2026 04:49
@bnbong bnbong self-assigned this May 17, 2026
@bnbong bnbong added the documentation Improvements or additions to documentation label May 17, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@bnbong bnbong merged commit 3403376 into main May 17, 2026
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS, I18N] German documentation localization

2 participants