Conversation
|
@codex review |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Codex Review: Didn't find any major issues. 👍 ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
There was a problem hiding this comment.
Pull request overview
Completes the Japanese (ja) documentation locale rollout for FastAPI-fastkit by adding the full set of translated pages under docs/ja/, aligning translation policy/status docs with the current localization workflow, and updating translation-status tables to reflect ja reaching 26/26 pages (with the canonical changelog remaining the repo-root English CHANGELOG.md).
Changes:
- Add full Japanese documentation coverage under
docs/ja/(user guide, tutorials, contributing, reference). - Update translation status pages (English + Korean + Japanese) to mark
jaas complete (26/26) and refresh snapshot date. - Add
docs/ja/changelog.mdas a wrapper that includes the canonical EnglishCHANGELOG.md.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ko/reference/translation-status.md | Updates the KO translation-status table to mark Japanese as complete and refreshes the snapshot note/date. |
| docs/ja/user-guide/using-templates.md | Adds Japanese translation for the “Using templates” user guide page. |
| docs/ja/user-guide/quick-start.md | Adds Japanese translation for the quick start guide. |
| docs/ja/user-guide/installation.md | Adds Japanese translation for installation instructions. |
| docs/ja/user-guide/creating-projects.md | Adds Japanese translation for project creation guidance. |
| docs/ja/user-guide/choosing-a-starter.md | Adds Japanese guide to choosing starters/presets vs templates. |
| docs/ja/user-guide/adding-routes.md | Adds Japanese translation for adding routes to an existing project. |
| docs/ja/tutorial/getting-started.md | Adds Japanese “getting started” tutorial. |
| docs/ja/tutorial/domain-starter.md | Adds Japanese tutorial for the domain-starter template/layout. |
| docs/ja/tutorial/basic-api-server.md | Adds Japanese tutorial for the basic API server template. |
| docs/ja/tutorial/async-crud-api.md | Adds Japanese tutorial for the async CRUD template. |
| docs/ja/reference/translation-status.md | Adds Japanese translation-status policy page (source-of-truth + fallback behavior + workflow). |
| docs/ja/reference/template-quality-assurance.md | Adds Japanese translation for template QA reference. |
| docs/ja/reference/preset-feature-matrix.md | Adds Japanese translation for preset/feature matrix reference. |
| docs/ja/reference/faq.md | Adds Japanese FAQ page. |
| docs/ja/contributing/translation-guide.md | Adds Japanese translation guide for the localization workflow. |
| docs/ja/contributing/template-creation-guide.md | Adds Japanese guide for creating templates. |
| docs/ja/contributing/code-guidelines.md | Adds Japanese translation of coding guidelines. |
| docs/ja/changelog.md | Adds Japanese changelog page that includes the canonical English changelog. |
| docs/en/reference/translation-status.md | Updates EN translation-status table to mark Japanese as complete and refreshes snapshot note/date. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### 2. API キーの設定 | ||
|
|
||
| OpenAI または Anthropic のいずれかの API キーが必要です: | ||
|
|
||
| ```bash | ||
| # OpenAI 用 | ||
| export TRANSLATION_API_KEY="sk-..." | ||
|
|
||
| # または Anthropic 用 | ||
| export TRANSLATION_API_KEY="sk-ant-..." | ||
| ``` |
| すべてのドキュメントは、まず英語で `docs/` ディレクトリに記述します: | ||
|
|
||
| ```bash | ||
| # 新しいドキュメントを作成 | ||
| vim docs/user-guide/new-feature.md |
| python_requires=">=3.8", | ||
| classifiers=[ | ||
| "Development Status :: 4 - Beta", | ||
| "Intended Audience :: Developers", | ||
| "License :: OSI Approved :: MIT License", | ||
| "Programming Language :: Python :: 3", | ||
| "Programming Language :: Python :: 3.8", | ||
| "Programming Language :: Python :: 3.9", | ||
| "Programming Language :: Python :: 3.10", | ||
| "Programming Language :: Python :: 3.11", |
Requesting Merging
Description
Part of #59
Refs #60
Closes #63
This PR completes the Japanese documentation localization rollout for FastAPI-fastkit and aligns the related Japanese translation policy/docs with the current localization workflow.
The main goal of this PR is to provide a complete Japanese locale under
docs/ja/, improve readability and terminology consistency across translated pages, and clarify that the repository-rootCHANGELOG.mdremains the canonical English release history.Type of Change
Test Environment
uvuv run mkdocs buildDocumentation built successfullyMajor Changes
Completed the Japanese docs locale under
docs/ja/26 / 26markdown pages presentImproved Japanese readability and terminology consistency
Updated translation policy and status docs
docs/en/) as the source of truthClarified changelog handling for localized docs
CHANGELOG.mdas the canonical English release historydocs/ja/changelog.mdto act as a Japanese entry point / wrapper for the canonical English changelog instead of maintaining a separate translated release historyRefined Japanese docs navigation and cross-page consistency
Screenshots (optional)
N/A
Etc