Files
JiangCheng 1d1df9235b feat(i18n): Add Japanese (ja/) translation (#105)
- Translate all 101 markdown files: P1 core, all 10 modules, examples,
  auxiliary docs (CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, CLAUDE.md, etc.),
  peripheral docs (.github/, docs/, resources/, scripts/)
- Translate comments and user-facing messages in 06-hooks/*.sh examples
- Copy 05-mcp/*.json examples (standard JSON, no comments)
- Update root README.md language switcher to include 日本語
- Add ja/TRANSLATION_NOTES.md (glossary + style guide)

All translations pass pre-commit quality gates (markdown-lint,
cross-references, mermaid-syntax, link-check, build-epub).
2026-04-30 00:16:46 +02:00

894 B


description: ソースコードから網羅的な API ドキュメントを生成する

API ドキュメント生成

次の手順で API ドキュメントを生成する:

  1. /src/api/ 配下の全ファイルをスキャンする
  2. 関数シグネチャと JSDoc コメントを抽出する
  3. エンドポイント/モジュール単位で整理する
  4. サンプル付きの Markdown を作成する
  5. リクエスト/レスポンスのスキーマを含める
  6. エラーに関するドキュメントを追加する

出力形式:

  • /docs/api.md に Markdown ファイルとして出力
  • 全エンドポイントについて curl のサンプルを含める
  • TypeScript の型定義を追加する

Last Updated: April 9, 2026