Skip to content

docs: README/getting-started のクイックスタート整理 + issues 追加#54

Merged
takemi-ohama merged 2 commits into
mainfrom
docs/trim-readme-quickstart
Jun 9, 2026
Merged

docs: README/getting-started のクイックスタート整理 + issues 追加#54
takemi-ohama merged 2 commits into
mainfrom
docs/trim-readme-quickstart

Conversation

@takemi-ohama

Copy link
Copy Markdown
Contributor

概要

README とユーザーガイドのクイックスタートを整理し、冗長な説明を削減しつつ「インストール後にプラグイン導入・起動へ進む」流れを明確化しました。あわせて issue #31 の指示書と PLAN31_2 設計書を issues/ に追加します。

関連 Issue

変更点

ドキュメント整理 (README.md / docs/user/getting-started.md)

  • ワンライナーの「&& 以降はサブシェルではなく呼び出し元シェルで動く」等のシェル仕組み解説(過剰説明)を削除
  • build ショートカット例外の実装詳細(cmd_build/Python・シェル実装)を README から除き、CLI リファレンスへ委譲(「挙動が一部異なる(詳細はリンク)」に集約)
  • curl | bash の確認手順を README から除去(getting-started には安全案内として残置)
  • 「主な特徴」の TUI list 項目を他項目と同じ1行粒度に統一
  • クイックスタートを 「1. インストール(ワンライナー/手動) → 2. プラグイン導入・プロジェクト起動」 に再構成し、ワンライナー実行後も共通フローへ合流できるよう明確化
  • getting-started 側も同じ過剰説明を整理

設計ドキュメント追加 (issues/)

  • issues/i31.md — 開発AIエージェント向け指示書(installer 簡略化・list TUI 統合・up時エディタ起動)
  • issues/PLAN31_2_list-tui-unified.mddevbase list TUI 統合UI化の設計書

動作確認

  • ドキュメントのみの変更のため、リンク切れ・アンカー整合を確認(章見出し変更による外部参照の破損なしを確認済み)
  • CI が green である

補足

issues/ の2ファイルは別作業(PLAN31_2)の成果物ですが、ユーザー指示により本PRに同梱しています。

takemi-ohama and others added 2 commits June 9, 2026 23:54
- ワンライナーのサブシェル仕組み解説など過剰説明を削除
- build ショートカット例外の実装詳細は CLI リファレンスへ委譲
- curl|bash 確認手順を README から除去 (getting-started には安全案内として残置)
- クイックスタートを「1.インストール(ワンライナー/手動) → 2.プラグイン導入・起動」に再構成し、ワンライナー後の手順を明確化

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@takemi-ohama takemi-ohama merged commit fd206c7 into main Jun 9, 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