docs: ドキュメント全体の監査・多角的修正(3ラウンド)#104
Merged
Merged
Conversation
Round 1 — 致命的な誤りと古いコマンド: - configure-auth.md (EN/JA): BEARER_TOKENS/API_KEYS をJSON配列形式に修正 (カンマ区切りはJSONDecodeErrorになる) - ja/reference/configuration.md: .env例のCORS_ORIGINS/BEARER_TOKENSをJSON配列形式に修正 - design-philosophy.md (EN/JA): 削除済みの `uv run export-openapi` を `uv run python src/scripts/export_openapi.py` に修正 - 全言語のテスト数を167+に統一(EN:165+, JA/DE/FR/ZH/PT-BR:135+ がすべて古かった) - sqlalchemy-repository.md (EN): セクション番号の飛び(4→6)を修正(→5)、末尾の孤立```を削除 - todo/current.md: v0.2.0作業中のTODOリスト(全タスク未完のまま放置)をv1.x完了後の状態に更新 Round 2 — 抜けと不整合: - new-project.md (EN): BearerTokenMiddleware/ApiKeyAuthMiddleware/CORSMiddlewareのimport文を追加 - configure-auth.md (EN/JA): TokenIssuerProtocol セクションをEN版に追加しJA版と整合 - configure-auth.md (EN/JA): importパスを nene2.auth トップレベルに統一 - architecture.md (EN/JA): schema.pyの説明に「新規プロジェクトはドメイン別ensure_schema」の注記追加 - ja/how-to/run-tests.md: テスト構造のサブディレクトリをEN版に合わせて列挙 - ja/how-to/sqlalchemy-repository.md: Section 5「transactional()を使った原子的マルチライト」を追加 (EN版には既に存在したがJA版に欠落していた) Round 3 — JA版の欠けているページ作成: - docs/ja/how-to/new-project.md: 新規作成(EN版 new-project.md の完全日本語翻訳) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ドキュメント全体を「古い内容」「抜け」「多言語整合性」の3つの観点から3ラウンドの確認を経て修正。
Round 1 — 致命的な誤りと古いコマンド
configure-auth.md(EN/JA):BEARER_TOKENS/API_KEYSをカンマ区切りで記載していたのをJSON配列形式に修正(カンマ区切りはJSONDecodeErrorになる)ja/reference/configuration.md:.env例のCORS_ORIGINS/BEARER_TOKENSも同様に修正design-philosophy.md(EN/JA): 削除済みのuv run export-openapiをuv run python src/scripts/export_openapi.pyに修正sqlalchemy-repository.md(EN): セクション番号 4→6 の飛びを修正・末尾の孤立```を削除todo/current.md: v0.2.0 作業中の TODO リスト(全タスク未完のまま放置)を v1.x 完了後の状態に更新Round 2 — 抜けと不整合
new-project.md(EN):BearerTokenMiddleware/ApiKeyAuthMiddleware/CORSMiddlewareの import 文を追加(コード例がself-containedでなかった)configure-auth.md(EN/JA):TokenIssuerProtocolセクションを EN 版に追加して JA 版と整合化configure-auth.md(EN/JA): import パスをnene2.authトップレベルに統一architecture.md(EN/JA):schema.pyの説明に「新規プロジェクトはドメイン別ensure_schema()」の注記を追加ja/how-to/run-tests.md: テスト構造のサブディレクトリを EN 版に合わせて列挙(...で省略されていた)ja/how-to/sqlalchemy-repository.md: Section 5「transactional()を使った原子的マルチライト」を追加(EN 版にはあったが JA 版に欠落)Round 3 — JA 版の欠けているページ
docs/ja/how-to/new-project.md: 新規作成(EN 版new-project.mdの完全日本語翻訳)Test plan
uv run pytest— 167 tests passed, 91.77% coverage🤖 Generated with Claude Code