Skip to content

docs: CLI リファレンスをグループ別に分割し repo 連携ガイドを追加#88

Open
takemi-ohama wants to merge 1 commit into
mainfrom
docs/cli-reference-split-and-repo-backed-guide
Open

docs: CLI リファレンスをグループ別に分割し repo 連携ガイドを追加#88
takemi-ohama wants to merge 1 commit into
mainfrom
docs/cli-reference-split-and-repo-backed-guide

Conversation

@takemi-ohama

Copy link
Copy Markdown
Contributor

概要

docs/ を執筆ルール(1 ファイルあたりの分量を抑える・図はインライン mermaid)に沿って整理し、外部リポジトリ連携プロジェクト向けの新ガイドを追加しました。ドキュメントのみの変更で、CLI の挙動には影響しません。

変更点

  • CLI リファレンスの分割: 740 行の docs/user/cli-reference.mddocs/user/cli-reference/ 配下に再編
    • README.md(目次・コマンド体系)+ 01-toplevel.md / 02-project.md / 03-env.md / 04-plugin.md / 05-snapshot.md
    • 各ファイル 300 行以内。目的のコマンドへ辿りやすくなる
  • repo 連携ガイドの新規追加: docs/plugin-dev/repo-backed-projects.md
    • アプリ本体のリポジトリを共有 work ボリュームへ取り込み、複数コンテナで動かすプロジェクト向けの pre-up populate パターンを解説
    • 初回のみ populate し、2 回目以降はコンテナ側のソース・環境ファイルを上書きしない冪等スキップの設計意図・更新運用・チェックリストを記載
  • 参照リンクの更新: 分割に伴い docs/README.md(索引・構成ツリー)、container-operations.mdenv-export-import.mdgetting-started.mdplugin-registries.mdquickstart.md の参照リンクを新パスへ張り替え
  • CHANGELOG: 上記 2 点を Unreleased に追記

動作確認

  • cli-reference.md への残存参照が無いことを確認(grep -rn "cli-reference.md" docs/ → 0 件)
  • 分割ファイル内の相対リンク・被リンクのアンカーが実在先へ解決することを確認
  • docs/ 配下の全 Markdown が 500 行以下であることを確認
  • GitHub 上でのレンダリング(mermaid 図・リンク遷移)を確認

補足

carmo-system-console の pre-up 本体(挙動変更)は別リポジトリ(volareinc/devbase-ext)にあり、この PR には含まれません。本 PR は devbase 本体リポジトリのドキュメントのみです。pre-up の実コード変更は devbase-ext 側で別途 PR が必要です。

- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant