Skip to content

docs: ドキュメント整合性修正と競合比較ドキュメント追加#6

Merged
takemi-ohama merged 2 commits intomainfrom
fix-doc-drift-from-report01
May 1, 2026
Merged

docs: ドキュメント整合性修正と競合比較ドキュメント追加#6
takemi-ohama merged 2 commits intomainfrom
fix-doc-drift-from-report01

Conversation

@takemi-ohama
Copy link
Copy Markdown
Contributor

@takemi-ohama takemi-ohama commented May 1, 2026

Pull Request

概要

外部レビュー(REPORT01)の指摘および全ドキュメント横断レビューで発見した 実装とドキュメントの差分 をまとめて修正し、あわせて競合ツール比較ドキュメントを新規追加する。

関連 Issue

  • Closes #

変更点

A. ドキュメント整合性修正(REPORT01 の指摘)

# 指摘 対応
1 `plugin-registries.md` の `repo sync` が実装の `refresh` と不一致 `devbase plugin repo sync` → `refresh`
2 `plugin-dev/quickstart.md` の `devbase shell` が現行CLIに存在しない `devbase shell` → `devbase login`
3 `CONTAINER_SCALE` デフォルト値が文書ごとに異なる(実装は `2`) `plugin-dev/quickstart.md` のデフォルト記述を `1` → `2`
4 README が snapshot 対象を「ホームボリューム」と記載(実装は `/work`) README.md を「`/work` ボリュームの増分バックアップ」に修正
5 `containers/php85/` がイメージ一覧に欠落 `container-operations.md` の mermaid と表、`quickstart.md` §5.4 に `php85` 行を追加

B. 全ドキュメント横断レビューで追加発見した差分

# 場所 内容
6 `docs/user/snapshot-guide.md:101` スナップショット保存先を `projects//backups/` → `${DEVBASE_ROOT}/backups/`(全プロジェクト共通)
7 `docs/user/getting-started.md:209` プロジェクト構成図の `backups/` を `projects//` 配下から devbase ルート直下に移動
8 `docs/user/troubleshooting.md:359` `du -sh projects//backups/` → `du -sh ${DEVBASE_ROOT}/backups/`
9 `docs/user/cli-reference.md:491` `snapshot rotate --keep` デフォルトを定数名 `DEFAULT_MAX_GENERATIONS` から実際の値 `3` に変更(cli.py:182 の `default=3` と整合)

C. 新規追加

  • `docs/comparison.md`: 競合ツール比較ドキュメント(DevPod / Daytona / Codespaces / Coder / Tilt / Skaffold / DevSpace / DDEV など、機能比較表・選定ガイド・移行ガイドを整理)

D. .gitignore

  • `issues/` を追加(ローカル作業用ディレクトリ)

棄却した指摘(参考)

  • 「`GIT_HOST` 環境変数が未実装」: `containers/base/entrypoint.sh:265-268` で実装済み(コンテナ起動時に `git clone https://$GIT_HOST/$GIT_USER/$GIT_REPO.git` で使用)

やらないこと

  • `LICENSE` の Copyright 表記は著作権表示として残置
  • 既存記述で実装と整合している箇所(`compose-yml-guidelines.md` 等)は変更しない

動作確認

  • `grep -rn "repo sync\|devbase shell" docs/` で誤った旧表記が出てこない
  • `grep -rn "CONTAINER_SCALE.*デフォルト" docs/` の値が `2` で統一されている
  • `grep -rn "projects/.*backups" docs/` でプロジェクト個別 backups 表記が残っていない
  • `docs/comparison.md` のリンク先がすべて到達可能
  • CI が green である

takemi-ohama and others added 2 commits May 2, 2026 07:14
REPORT01の指摘に基づく修正:
- plugin-registries.md: 'repo sync' を実装と一致する 'repo refresh' に修正
- plugin-dev/quickstart.md: 存在しない 'devbase shell' を 'devbase login' に修正
- plugin-dev/quickstart.md: CONTAINER_SCALE のデフォルト値を実装(2)と一致させる
- README.md: snapshot対象を 'ホームボリューム' から '/work ボリューム' に修正
  (snapshot-guide.md および実装と整合)
- container-operations.md / quickstart.md: php85 イメージを一覧に追加

その他:
- docs/comparison.md: 競合ツール比較ドキュメントを新規追加
- .gitignore: issues/ を追加(ローカル作業用ディレクトリ)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
全ドキュメントレビューで検出した実装との差分を修正:

- snapshot-guide.md: スナップショット保存先を 'projects/<project>/backups/' から
  '\${DEVBASE_ROOT}/backups/'(全プロジェクト共通)に修正
  (lib/devbase/snapshot/manager.py:30 と整合)
- getting-started.md: プロジェクト構成図の backups/ を devbase ルート直下に移動
- troubleshooting.md: 'du -sh projects/<project>/backups/' を
  'du -sh \${DEVBASE_ROOT}/backups/' に修正
- cli-reference.md: 'snapshot rotate --keep' のデフォルト記述を
  定数名 'DEFAULT_MAX_GENERATIONS' から実際の値 '3' に変更
  (lib/devbase/cli.py:182 の argparse default=3 と整合)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@takemi-ohama takemi-ohama merged commit 9a4e038 into main May 1, 2026
5 checks passed
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