Pokemon Card AI Documentation¶
このサイトは、Pokemon TCG AI Battle Challenge 向けエージェント実装の設計・運用・実験メモを読むための入口です。
最初に読む¶
| 目的 | 読むもの |
|---|---|
| 現在の手法を理解する | 現在の手法 |
src/pca/ の実装を追う |
実装設計, モジュール別説明 |
| 目的別に最短経路で読む | Reading Guide |
| 処理フローを見る | Flow Diagrams |
| API / 生成物 / テストを見る | API Reference, Artifacts, Test Map |
| 実行手順を確認する | Operations |
コマンド¶
ローカルで HTML として確認する場合:
uv sync --group docs
mise run docs:serve
VS Code 上で見る場合は、Command Palette から Tasks: Run Task を選び、docs: serve
を起動します。その後、Command Palette で Simple Browser: Show を実行して http://127.0.0.1:8000
を開きます。task の実体は mise.toml の docs:serve です。
静的サイトを生成する場合:
mise run docs:build
private repository で共有する場合は、GitHub Actions の docs-artifact workflow が site/
を artifact として保存します。GitHub Pages へ公開 deploy は行いません。artifact を展開して
index.html を直接開く前提のため、リンクは *.html 形式で生成します。
既存文書には src/、configs/、scripts/
など docs 外への相対リンクも含まれるため、docs 外参照は MkDocs の validation 設定で情報ログとして扱います。
文書の扱い¶
- 現行仕様は architecture/ を優先します。
- 実行手順は operations/ に置きます。
- 実験履歴や古い仮説は
research/とjournal/に残しますが、サイト artifact からは除外しています。 - 公開 API、CLI option、JSONL schema、checkpoint payload、生成 CSV を変えたら モジュール別説明 も更新します。