Skip to content
This repository was archived by the owner on Jul 13, 2026. It is now read-only.

docs: reorganize README with Quick Start section#335

Merged
tjackiet merged 2 commits into
mainfrom
claude/readme-structure-clarity-x7fbyg
Jul 6, 2026
Merged

docs: reorganize README with Quick Start section#335
tjackiet merged 2 commits into
mainfrom
claude/readme-structure-clarity-x7fbyg

Conversation

@tjackiet

@tjackiet tjackiet commented Jul 6, 2026

Copy link
Copy Markdown
Owner

概要

README を再構成し、「クイックスタート」セクションを前面に出しました。ユーザーが最初に目にする情報を「CLI のグローバルインストール」に統一し、その後に Plugin 導入や開発手順を配置する流れに改善しています。

変更内容

  • クイックスタート を新規セクションとして追加し、npm i -g bitbank-lab-cli による最小限のセットアップを明確化
  • Plugin インストール手順を「クイックスタート後の選択肢」として再配置
  • 開発セクション(クローン + ./install.sh)を独立させ、ユースケース別に整理
  • 各 IDE / CLI ツール(Claude Code / Cursor / Codex / Antigravity)の Plugin 導入手順を簡潔化
  • 冗長な説明を削減し、重要な注釈(macOS Xcode 要件、自動更新なし等)を残す

構成の改善

Before After
Plugin インストール(最初) クイックスタート(最初)
Claude Code / Cursor / Codex 詳細説明 Plugin インストール(選択肢)
クイックスタート(後ろ) 開発(クローン手順)

チェックリスト

  • ドキュメント更新のみ(コード変更なし)
  • シークレット情報を含めていない
  • 実行可能なコマンド例を確認

テスト

N/A(ドキュメント変更のみ)

https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1

- クイックスタートを主な提供物の直後に移動し、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
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary

README を再構成し、導入手順の先頭に Quick Start を追加しました。グローバル CLI のインストール、プラグイン導入、開発環境セットアップの流れを整理し、各クライアント向け手順と注意事項を簡潔にしました。

Category

  • 📚 Docs / tests

Risk Level

  • 🟢 Low

Impact

  • README.md
  • bitbank-lab-cli の導入手順
  • Claude Code / Cursor / Codex CLI / Antigravity CLI のプラグイン設定案内
  • 開発用セットアップ手順(clone、./install.shnpx tsx cli/index.ts

Walkthrough

README.md の案内導線を整理し、クイックスタートと plugin 導入手順を更新しました。あわせてセットアップ節を参照集約し、トラブルシューティングと開発時のフォールバック手順を差し替えています。

Changes

README更新

Layer / File(s) Summary
クイックスタートとplugin導入手順の改訂
README.md
グローバルインストール、動作確認、npx 試用、アンインストール手順を再記述し、Plugin 節を CLI 本体別途必須の前提で全面改稿。Claude Code / Cursor / Codex CLI / Antigravity CLI の手順も更新。
セットアップ節のクイックスタート参照化
README.md
「1. インストール」節の詳細手順を削除し、クイックスタート参照へ集約。
開発フォールバックとトラブルシューティング更新
README.md
./install.sh を基本手順として整理し、npm link を使わない場合の npx tsx cli/index.ts 系の実行方法を明記。bitbank: command not found の案内先も更新。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • tjackiet/bitbank-lab-cli#309: README のインストール/セットアップや plugin 導線の参照更新が同じ文書領域で重なっています。

Suggested labels: docs

Poem

ぴょんぴょん README を読み直し
迷い道の案内がすっきり整う 🐇
plugin は Skills、本体もお忘れなく
install.sh で準備して、すぐにひと跳ね
もう道しるべは、ふわっと軽やか♪

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed README の Quick Start 追加と再構成という主要変更を的確に表しており、簡潔です。
Description check ✅ Passed 概要、変更内容、構成比較、チェックリスト、テスト状況が揃っており、テンプレート要件を概ね満たしています。
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/readme-structure-clarity-x7fbyg

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added the docs label Jul 6, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7a1cb78 and a201313.

📒 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)

Comment thread README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.jsontjackiet/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

📥 Commits

Reviewing files that changed from the base of the PR and between a201313 and 25ea1b5.

📒 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)

@tjackiet tjackiet merged commit 4cb98f3 into main Jul 6, 2026
5 checks passed
@tjackiet tjackiet deleted the claude/readme-structure-clarity-x7fbyg branch July 6, 2026 02:18
@tjackiet tjackiet mentioned this pull request Jul 6, 2026
8 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants