docs: reorganize README with Quick Start section#335
Conversation
- クイックスタートを主な提供物の直後に移動し、npm i -g と動作確認だけに絞る - クローン手順・npx tsx フォールバック・npm run alias は開発セクションへ移設 - Plugin 節を「Skill は必要に応じて plugin で追加」の位置づけで簡潔化 (Claude Code の手順を圧縮、Cursor の導入経路 A を intro に統合、 Codex のステップをコードブロックに集約、Antigravity の重複記述を削除) - Troubleshooting / セットアップの参照リンクを移設先に合わせて更新 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1
📝 WalkthroughSummaryREADME を再構成し、導入手順の先頭に Quick Start を追加しました。グローバル CLI のインストール、プラグイン導入、開発環境セットアップの流れを整理し、各クライアント向け手順と注意事項を簡潔にしました。 Category
Risk Level
Impact
WalkthroughREADME.md の案内導線を整理し、クイックスタートと plugin 導入手順を更新しました。あわせてセットアップ節を参照集約し、トラブルシューティングと開発時のフォールバック手順を差し替えています。 ChangesREADME更新
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 109-125: The three fenced blocks in the README need language info
to satisfy MD040 and avoid rendering/lint noise. Update the Markdown around the
plugin install examples and the GitHub URL so each fenced code block in this
section is explicitly tagged with an appropriate language such as bash or text,
using the existing README content as the anchor.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9aef6643-013d-41d4-ae6b-5cc248e6ed09
📒 Files selected for processing (1)
README.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
bitbankinc/bitbank-api-docs(manual)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
109-125: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win配布先スラッグを統一してください。
README.mdの/plugin marketplace addと Cursor の URL はbitbankinc/bitbank-lab-cliを案内していますが、.claude-plugin/plugin.jsonはtjackiet/bitbank-lab-cliを公開元として持っています。どちらかを正にして、README と manifest を同じリポジトリに揃えてください。🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 109 - 125, 配布元スラッグが README と manifest で不一致です。`.claude-plugin/plugin.json` の公開元情報と README の `/plugin marketplace add`、Cursor の GitHub URL を同じリポジトリ名に統一し、`bitbank-lab-cli` の案内先を一方に揃えてください。`plugin.json` の配布情報と README のインストール手順の両方を確認して、ユーザーが同じ正しいスラッグ/URLで導線をたどれるように修正してください。
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README.md`:
- Around line 109-125: 配布元スラッグが README と manifest
で不一致です。`.claude-plugin/plugin.json` の公開元情報と README の `/plugin marketplace
add`、Cursor の GitHub URL を同じリポジトリ名に統一し、`bitbank-lab-cli`
の案内先を一方に揃えてください。`plugin.json` の配布情報と README
のインストール手順の両方を確認して、ユーザーが同じ正しいスラッグ/URLで導線をたどれるように修正してください。
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 936acba7-72ab-485b-a1c9-26f154d9b405
📒 Files selected for processing (1)
README.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
bitbankinc/bitbank-api-docs(manual)
概要
README を再構成し、「クイックスタート」セクションを前面に出しました。ユーザーが最初に目にする情報を「CLI のグローバルインストール」に統一し、その後に Plugin 導入や開発手順を配置する流れに改善しています。
変更内容
npm i -g bitbank-lab-cliによる最小限のセットアップを明確化./install.sh)を独立させ、ユースケース別に整理構成の改善
チェックリスト
テスト
N/A(ドキュメント変更のみ)
https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1