docs: CLI リファレンスをグループ別に分割し repo 連携ガイドを追加 - #88
Conversation
- docs/user/cli-reference.md (740行) を docs/user/cli-reference/ 配下の 目次 + グループ別ファイル (toplevel/project/env/plugin/snapshot) に分割 - docs/plugin-dev/repo-backed-projects.md を新規追加 (外部リポジトリを共有 work ボリュームへ populate する pre-up パターンの解説) - 分割に伴い README 索引・各ドキュメントの参照リンクを新パスへ更新 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 1 | codex | REQUEST_CHANGES
CLI リファレンス分割後の参照更新範囲と、repo-backed 構成のスケール時ボリューム前提を現行実装に合わせて修正してください。
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 1 | gemini | REQUEST_CHANGES
リポジトリルートの README.md に旧 docs/user/cli-reference.md へのリンクが残っています。変更対象外となっていますが合わせて更新をお願いします。
- ルート README.md の CLI リファレンス参照 3 箇所を旧パス `docs/user/cli-reference.md` から分割後の `docs/user/cli-reference/README.md` へ更新(ショートカット節のアンカーも新目次側へ)。 - repo-backed-projects.md に「スケール前提: CONTAINER_SCALE=1」節を追加。 現行実装では pre-up がインデックスなしで 1 回しか実行されず (DEVBASE_INSTANCE_INDEX は deploy フックにのみ付与)、scale 生成で /work が devbase_work_<index> へ差し替わるのは dev サービスのみのため、scale>1 では 「全コンテナが同一ソースを共有する」前提が崩れることを明記。 - DEVBASE_INSTANCE_INDEX / DEVBASE_WORK_VOLUME の説明を実装に合わせて修正。 - 再 populate 手順の `docker volume rm` を external volume の実名 (`devbase_work_1`、project 接頭辞なし) に訂正。 - リファレンス実装 `carmo-system-console` が本リポジトリに含まれない (private レジストリ配布 / projects/ は .gitignore 対象) 旨を明記。 - CHANGELOG のリンク更新記述をルート README 含む形へ補記し、旧リリース項の cli-reference.md リンク切れも解消。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014zSgR8NvrkE6PeK5RRV82X
🔧 cross-review round 1 — fix 対応完了修正コミット: 対応サマリ
重要度は AI のラベルを鵜呑みにせず、 個別対応[major] ルート
[major] repo 連携ガイドの scale 前提が実装と不一致(codex #discussion_r3762475140) 実装確認の結果、指摘は正確でした。
対応として
[minor]
CIpush 前スナップショット時点で FAILURE なし(Python syntax check 3.10/3.11/3.12・Ruff lint・ShellCheck すべて SUCCESS)。docs 変更のみのため実行系への影響はありません。再レビューをお願いします。 |
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 2 | codex | REQUEST_CHANGES
共有 work ボリュームの分離手順と削除手順を、現行の scale 生成・グローバル volume 命名に対して安全に成立する内容へ修正してください。
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 2 | gemini | APPROVE
ドキュメントの分割と新規追加の内容に問題は見当たりませんでした。既存ドキュメント・関連ファイルからの参照リンクも漏れなく更新されており、各ファイルの内容や見出しレベルの階層も適切です。
- repo 連携ガイド 2 章: 「プロジェクト複製 + DEVBASE_WORK_VOLUME で並行化」という
成立しない手順を削除し、同一リポジトリの複数インスタンス分離が未サポートである旨と
その理由(scale 生成が dev の /work を devbase_work_<index> へ無条件差し替え、
work ボリュームが COMPOSE_PROJECT_NAME 非依存のグローバル名)を明記。
- repo 連携ガイド 5 章: 再 populate 手順を `docker volume rm devbase_work_1` から
`/work/<GIT_REPO>` サブディレクトリ削除へ変更。ボリュームが全プロジェクト共有である
警告と、ボリュームごと消す場合の事前確認手順(docker ps --filter volume=)を追加。
- 6 章 DEVBASE_WORK_VOLUME の説明を「非 dev サービスにのみ効く」へ訂正。
- container-operations.md: ボリューム表の `{project}_work_{index}` /「各コンテナ専用」を
実装どおり `devbase_work_{index}` / プロジェクト間共有へ訂正し、削除時の警告を追記。
- CHANGELOG に上記を反映。
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014zSgR8NvrkE6PeK5RRV82X
🔧 cross-review round 2 — fix 対応完了修正コミット: 対応サマリ
round 1 で対応済みの 3 スレッドは Resolve 済みのため対象外とし、未 Resolve の open thread 2 件(いずれも codex round 2)のみを扱いました。gemini は round 2 で APPROVE です。 重要度は AI のラベルを鵜呑みにせず、 個別対応[major] 2 章の並行化手順が現行実装で成立しない(#discussion_r3762537770) 実装確認の結果、指摘は正確でした。
よって「複製 + [major] 再 populate 手順の 同じく実装で裏付けが取れました。プロジェクトの分離単位はボリュームではなく
あわせて修正した整合性の問題(指摘外) この PR で参照リンクを更新している 検証
再レビューをお願いします。 |
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 3 | codex | APPROVE
新たに修正が必要な事項はありません。
takemi-ohama
left a comment
There was a problem hiding this comment.
🤖 cross-review | round 3 | gemini | APPROVE
ドキュメントの分割、参照リンクの更新、および新規ドキュメント(repo 連携プロジェクト)の追加について、矛盾やリンク切れなどの問題は見当たりませんでした。
概要
docs/を執筆ルール(1 ファイルあたりの分量を抑える・図はインライン mermaid)に沿って整理し、外部リポジトリ連携プロジェクト向けの新ガイドを追加しました。ドキュメントのみの変更で、CLI の挙動には影響しません。変更点
docs/user/cli-reference.mdをdocs/user/cli-reference/配下に再編README.md(目次・コマンド体系)+01-toplevel.md/02-project.md/03-env.md/04-plugin.md/05-snapshot.mddocs/plugin-dev/repo-backed-projects.mdpre-uppopulate パターンを解説docs/README.md(索引・構成ツリー)、container-operations.md、env-export-import.md、getting-started.md、plugin-registries.md、quickstart.mdの参照リンクを新パスへ張り替え動作確認
cli-reference.mdへの残存参照が無いことを確認(grep -rn "cli-reference.md" docs/→ 0 件)docs/配下の全 Markdown が 500 行以下であることを確認補足
carmo-system-console の
pre-up本体(挙動変更)は別リポジトリ(volareinc/devbase-ext)にあり、この PR には含まれません。本 PR は devbase 本体リポジトリのドキュメントのみです。pre-upの実コード変更は devbase-ext 側で別途 PR が必要です。