Skip to content

docs: README/ドキュメントを現状の階層メニュー TUI に合わせて更新#67

Merged
takemi-ohama merged 2 commits into
mainfrom
docs/tui-current-state
Jun 13, 2026
Merged

docs: README/ドキュメントを現状の階層メニュー TUI に合わせて更新#67
takemi-ohama merged 2 commits into
mainfrom
docs/tui-current-state

Conversation

@takemi-ohama

Copy link
Copy Markdown
Contributor

Pull Request

概要

PR #63#66 の TUI 変更(破壊的操作以外の確認プロンプト廃止 / 操作後の Enter 待ち / 環境変数メニュー再構成 / 最下部固定の横並びメニューバー)を反映し、README とユーザー/開発者ドキュメントを実装と整合させる。コード変更は含まない。

関連 Issue

変更点

README.md

  • 機能紹介を「対話的なプロジェクト選択」→「階層メニュー TUI」へ刷新。プロジェクト操作(up/down/login/ps/logs/scale/build/rebuild)と、最下部の常設カテゴリメニュー(環境変数 / プラグイン / スナップショット / ステータス)への ←→ 移動を明記
  • コマンド一覧の抜けを補完(project に rebuild、plugin に migrate

docs/user/cli-reference.md

  • devbase project list セクションを全面刷新。「番号入力で選択」の旧説明を廃止し、TUI の画面構成図・キー操作表・カテゴリ別操作一覧・確認プロンプトの範囲を追加
  • 操作後の Enter 待ち、TUI が出さないオプション(env get/set/delete/export/import、plugin install --link/--all、snapshot create --full、logs --follow 等)は CLI を使う旨を記載
  • コマンドツリー図に rebuild / export / import / migrate を追加

docs/user/container-operations.md

  • プロジェクト一覧の説明を TUI 前提に更新し、詳細を cli-reference へリンク

docs/developer/architecture.md

  • 構成図・commands 表に project.py(list/TUI)を追加し、cmd_project が実体としては container.py 側にある実態を反映
  • tui/ の階層メニュー TUI 節とモジュール構成表(app/menu/flow/dispatch/actions_*)を新設

動作確認

  • 記載した CLI サブコマンド・モジュール構成を実装(cli.py / lib/devbase/tui/)と照合
  • ドキュメント内アンカーリンク(cli-reference.md#devbase-project-list / #project-グループ)の整合を確認
  • GitHub 上で mermaid 図・表のレンダリングを目視確認

補足

  • ドキュメント上の CLI コマンド一覧に、TUI とは無関係に元々抜けていた project rebuild / plugin migrate / env exportimport を実装と照合して補完した(意図的な省略ではなく漏れと判断)
  • コード・テストの変更はないため pytest は実行していない

🤖 Generated with Claude Code

PR #63#66 の TUI 変更 (確認プロンプト整理 / Enter 待ち / env メニュー再構成 /
最下部メニューバー) を反映し、ドキュメントを実装と整合させる。

- README: 「対話的なプロジェクト選択」を「階層メニュー TUI」へ刷新。
  プロジェクト操作と最下部カテゴリメニュー (←→ 移動) を明記
- cli-reference: `devbase project list` を全面刷新。番号入力の旧説明を廃止し、
  TUI の画面構成図・キー操作表・カテゴリ別操作一覧・確認プロンプトの範囲を追加
- container-operations: プロジェクト一覧の説明を TUI 前提に更新し詳細へリンク
- architecture: 構成図と commands 表に project.py / tui/ を追加。tui/ の
  モジュール構成表を新設。cmd_project が container.py 側にある実態を反映
- 既存ドキュメントに元々抜けていた CLI サブコマンド (project rebuild /
  plugin migrate / env export・import) をコマンド一覧・ツリー図に補完

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 2 | codex | REQUEST_CHANGES

rebuild 追加に伴う CLI ドキュメント内の整合性を直してください。

Comment thread docs/user/cli-reference.md Outdated
Comment thread README.md
Comment thread docs/developer/architecture.md

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 1 | codex | APPROVE

重複を除いて、このラウンドで追加すべき修正指摘はありません。

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 1 | gemini | COMMENT

TUI 操作のキー説明の補足と、追加されたコマンドの参照先について提案しました。

Comment thread docs/user/cli-reference.md Outdated
Comment thread docs/user/cli-reference.md
…xport-import 補記)

- architecture.md: SHORTCUTS 行を実装に整合 (up/down/login/ps/scale/rebuild、build 除外・list 個別 routing)
- cli-reference.md: ショートカット表とツリーに rebuild [name] 追加、project rebuild 個別節を新設
- cli-reference.md: TUI Enter キー説明にカテゴリメニューフォーカス時の遷移を併記
- cli-reference.md: env export/import 個別節を新設し env-export-import.md へリンク
- README.md: ショートカット一覧に rebuild [name] 追加

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@takemi-ohama takemi-ohama merged commit 44c0fbd into main Jun 13, 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