docs: CLI リファレンスをグループ別に分割し repo 連携ガイドを追加#88
Open
takemi-ohama wants to merge 1 commit into
Open
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
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 が必要です。