Skip to content

[DOCS] es translation#69

Merged
bnbong merged 2 commits into
mainfrom
dev
May 11, 2026
Merged

[DOCS] es translation#69
bnbong merged 2 commits into
mainfrom
dev

Conversation

@bnbong
Copy link
Copy Markdown
Owner

@bnbong bnbong commented May 11, 2026

Requesting Merging

Description

Part of #59
Refs #60
Closes #64

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

The main goal of this PR is to provide a complete Spanish locale under docs/es/, 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 Spanish docs locale under docs/es/

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

    • Reworked translation-style phrasing into more natural Spanish
    • Standardized visible link labels, explanatory text, and glossary-like 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 Spanish 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/es/changelog.md to act as a Spanish entry point / wrapper for the canonical English changelog instead of maintaining a separate translated release history
    • Adjusted related wording in Spanish policy/reference pages accordingly
  • Refined Spanish 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 11, 2026
@bnbong bnbong self-assigned this May 11, 2026
@bnbong bnbong added the documentation Improvements or additions to documentation label May 11, 2026
@bnbong bnbong requested a review from Copilot May 11, 2026 06:16
@bnbong
Copy link
Copy Markdown
Owner Author

bnbong commented May 11, 2026

@codex review

@github-actions github-actions Bot added the template Add or editing a FastAPI template label May 11, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Already looking forward to the next diff.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

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.

Pull request overview

This PR completes the Spanish (es) documentation locale for FastAPI-fastkit and updates translation status references across locales to reflect Spanish coverage, including switching the Spanish changelog page to a wrapper that reuses the canonical root CHANGELOG.md.

Changes:

  • Add/complete Spanish documentation pages under docs/es/ (user guide, tutorials, contributing, reference) and add docs/es/changelog.md as a wrapper include.
  • Update translation status tables in en, ja, and ko docs to mark Spanish as complete (26 / 26) and refresh the snapshot date.
  • Add/refresh Spanish “translation status” and related policy/reference pages to align with the current i18n workflow.

Reviewed changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/ko/reference/translation-status.md Marks Spanish as complete and updates the snapshot note/date.
docs/ja/reference/translation-status.md Marks Spanish as complete and updates the snapshot note/date.
docs/en/reference/translation-status.md Marks Spanish as complete and updates the snapshot note/date.
docs/es/index.md Adds Spanish landing page content and navigation entry points.
docs/es/changelog.md Adds Spanish changelog wrapper that includes canonical CHANGELOG.md.
docs/es/reference/translation-status.md Adds Spanish translation-status source-of-truth and workflow explanation.
docs/es/user-guide/installation.md Adds Spanish installation guide.
docs/es/user-guide/quick-start.md Adds Spanish quick-start guide.
docs/es/user-guide/choosing-a-starter.md Adds Spanish “choosing a starter” guidance.
docs/es/user-guide/creating-projects.md Adds Spanish project creation guide.
docs/es/user-guide/adding-routes.md Adds Spanish “adding routes” guide.
docs/es/user-guide/using-templates.md Adds Spanish “using templates” guide.
docs/es/tutorial/getting-started.md Adds Spanish getting-started tutorial.
docs/es/tutorial/basic-api-server.md Adds Spanish basic API server tutorial.
docs/es/tutorial/async-crud-api.md Adds Spanish async CRUD tutorial.
docs/es/tutorial/domain-starter.md Adds Spanish domain-starter tutorial.
docs/es/reference/preset-feature-matrix.md Adds Spanish preset/feature matrix reference.
docs/es/reference/template-quality-assurance.md Adds Spanish template QA reference.
docs/es/reference/faq.md Adds Spanish FAQ reference.
docs/es/contributing/translation-guide.md Adds Spanish translation guide aligned with current workflow/policy.
docs/es/contributing/template-creation-guide.md Adds Spanish template creation guide.
docs/es/contributing/code-guidelines.md Adds Spanish code guidelines.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 39 to 45
| 🇨🇳 Chinese (`zh`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
| 🇪🇸 Spanish (`es`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
| 🇪🇸 Spanish (`es`) | ✅ Complete | 26 / 26 | All locale pages are present. Phase 1: top-level + core user-guide; Phase 2: remaining user-guide + all tutorials; Phase 3: contributing + reference. `docs/es/changelog.md` intentionally reuses the canonical English `CHANGELOG.md`. |
| 🇫🇷 French (`fr`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
| 🇩🇪 German (`de`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |

*Snapshot verified 2026-05-10; ja row recounted for the current branch after Phase 3 (contributing + reference) landed. Japanese now has all locale pages present, while `docs/ja/changelog.md` intentionally points to the canonical English changelog.* These counts are maintained by hand;
*Snapshot verified 2026-05-11; es row recounted for the current branch after Phase 3 (contributing + reference) landed. Spanish now has all locale pages present, while `docs/es/changelog.md` intentionally points to the canonical English changelog.* These counts are maintained by hand;
to recount the current state from the repo root, run:
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

@copilot apply changes based on this feedback

@bnbong bnbong changed the title [DOCS] ja translation [DOCS] es translation May 11, 2026
@bnbong bnbong merged commit f6600a8 into main May 11, 2026
18 of 19 checks passed
Copilot stopped work on behalf of bnbong due to an error May 11, 2026 06:22
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 template Add or editing a FastAPI template

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS, I18N] Spanish documentation localization

2 participants