What it is
kouchou-ai のメインリポジトリ digitaldemocracy2030/kouchou-ai。MkDocs サイトとして docs/ 配下にユーザ向け/開発者向けドキュメントがある。開発者ドキュメントは特に docs/development/:
| Path | 中身 |
|---|---|
README.md, docs/index.md | プロジェクト概要、4 サービス構成、quick start |
docs/development/why-pnpm.md | npm 非対応の理由(plugin の strict isolation 要件) |
docs/development/why-plugin-system.md | plugin-system 採用の動機 |
docs/development/plugin-guide.md | plugin 作成手順 |
docs/development/plugin-output-data-structures.md | pipeline が出力する CSV / JSON のスキーマと注意点 |
docs/development/pypi-release.md | kouchou-ai-analysis-core の PyPI リリース手順 |
docs/development/devin-collaboration.md, ai-assistants.md | AI コーディング協働 の運用ルール |
docs/testing.md | テスト体系 |
docs/deployment/azure.md | Azure 本番運用手順 |
skills/kouchou-ai-{architecture,development,testing}/SKILL.md | Claude Code / Codex 用の凝縮版リファレンス。実は本体ドキュメントより簡潔で参考になる |
CONTRIBUTING.md, CLA.md, CODE_REVIEW_GUIDELINES.md, PROJECTS.md | 貢献ガバナンス |
compose.yaml, Makefile, .env.example, lefthook.yml, pnpm-workspace.yaml | 設定実体 |
How to consume
GitHub Web から、または gh api repos/digitaldemocracy2030/kouchou-ai/contents/<path> -H "Accept: application/vnd.github.raw" で取得可能。MkDocs ビルド済み版は https://digitaldemocracy2030.github.io/kouchou-ai/ で公開。
Notable observations
skills/ディレクトリが侮れない: Claude Code / Codex 向けに凝縮されたアーキテクチャ/開発/テストの SKILL.md がある。新規コントリビュータの onboarding にはdocs/より先に読むのが効率的CLAUDE.mdは薄い: 上記skills/3 本へのポインタのみ- テスト関連 CI ワークフロー (
docs/testing.mdで列挙):server-pytest.yml,client-jest.yml,client-admin-jest.yml,e2e-tests.yml,ruff-check.yml。フロントエンドの Biome は lefthook 上ではskip: trueで CI も明示されていない — バックエンドより強制力が弱い
Open Questions
pnpm-workspace.yamlはplugins/*を workspace に含めているが top-level のplugins/ディレクトリは存在しない(input plugin はapps/api/src/plugins/配下)。先行宣言なのか歴史的残骸なのか不明static-site-builder(port 3200)はskills/には載っているが README のアーキテクチャ図にはない。README だけ読む新規コントリビュータは存在を見落とす
Updates
- 2026-05-17: 初回 ingest(
init.txtの指示に基づくリポジトリ全体把握)