chore: sync English docs with the finalized Japanese V3 documentation - #2076
Open
hatayama wants to merge 16 commits into
Open
chore: sync English docs with the finalized Japanese V3 documentation#2076hatayama wants to merge 16 commits into
hatayama wants to merge 16 commits into
Conversation
The list has always contained 18 entries; the 19th directory under .claude/skills is the HelloWorld sample from this development project, which is not part of the bundle.
Apply every change from the Japanese-first review pass to the English docs: - README.md: new CRT logo with Human After All credit, What's New / migration links, hands-on verification in the concept, no-Node.js note, verified one-block terminal install with auto tag resolution, Settings window screenshots, pause-point skill row and 18-skill list, Claude Code sandbox configuration section, How It Works section, and the tool reference / custom tool guide extractions with the stale .claude/rules/cli.md tip and the Go CLI contributor section removed - whats-new-v3.md: three-paragraph intro without the Highlights section, three-step upgrade including Install Skills, --dry-run note, and the Removed list trimmed to changes actually made since the last V2 release - migration-v2-to-v3.md: replace the five screenshot placeholders with the four captured images, describe the auto-open status with the count-bearing wording, and note that six listed commands were already gone in the final V2 release - tools.md, custom-tools.md: new English counterparts of the extracted Japanese reference pages
Contributor
📝 WalkthroughWalkthroughThis documentation update adds custom tool and built-in tool guides, revises V2-to-V3 migration and release notes, and updates README installation, Skills, CLI, configuration, and feature descriptions. ChangesV3 Documentation Refresh
Estimated code review effort: 2 (Simple) | ~15 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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 `@Packages/src/Documentation`~/custom-tools.md:
- Line 104: Update the directory-tree fenced code block in custom-tools.md to
include a text or plaintext language identifier immediately after its opening
fence, preserving the existing directory-tree content.
- Line 91: Update the sample-reference links in custom-tools.md, including the
links at both referenced locations, to use repository-relative paths such as
../../../Assets/... instead of leading /Assets/... paths. Preserve the existing
link targets and link text.
In `@Packages/src/Documentation`~/tools.md:
- Line 155: Replace the standalone attachment URL in the tools documentation
with Markdown image syntax, using descriptive alt text such as “Mouse UI
example” and preserving the existing asset URL as the image source.
- Line 26: Update the three remaining fenced code blocks in tools.md, including
the blocks near the referenced locations, to specify an appropriate language
identifier such as text. Preserve each block’s existing content while adding the
identifiers needed to satisfy markdownlint MD040.
In `@README.md`:
- Line 308: Update the sandbox guide link in the README to use the
repository-relative target docs/claude-code-sandbox.md instead of the
leading-slash site-root path, preserving the existing link text and surrounding
explanation.
🪄 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: CHILL
Plan: Pro Plus
Run ID: 856d0853-444c-4645-af92-d68d580d0261
📒 Files selected for processing (6)
Packages/src/Documentation~/custom-tools.mdPackages/src/Documentation~/migration-v2-to-v3.mdPackages/src/Documentation~/tools.mdPackages/src/Documentation~/whats-new-v3.mdREADME.mdREADME_ja.md
| } | ||
| ``` | ||
|
|
||
| Please also refer to [Custom Tool Samples](/Assets/Editor/CustomCommandSamples). |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use repository-relative links for the sample references.
The leading /Assets/... paths resolve from the host root rather than this repository in GitHub-style Markdown, so both links can fail. Use the repository-relative equivalent, such as ../../../Assets/....
Also applies to: 134-134
🤖 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 `@Packages/src/Documentation`~/custom-tools.md at line 91, Update the
sample-reference links in custom-tools.md, including the links at both
referenced locations, to use repository-relative paths such as
../../../Assets/... instead of leading /Assets/... paths. Preserve the existing
link targets and link text.
| 4. LLM tools will automatically recognize your custom skill | ||
|
|
||
| **Directory structure:** | ||
| ``` |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language identifier to the directory-tree fence.
Use text or plaintext after the opening fence; this currently violates markdownlint MD040.
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 104-104: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@Packages/src/Documentation`~/custom-tools.md at line 104, Update the
directory-tree fenced code block in custom-tools.md to include a text or
plaintext language identifier immediately after its opening fence, preserving
the existing directory-tree content.
Source: Linters/SAST tools
| **Advanced Search Features**: | ||
| - **Regular Expression Support**: Use `UseRegex: true` for powerful pattern matching | ||
| - **Stack Trace Search**: Use `SearchInStackTrace: true` to search within stack traces | ||
| ``` |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add language identifiers to the remaining fenced blocks.
These three fences trigger markdownlint MD040. Mark the example blocks as text (or another appropriate language).
Also applies to: 117-117, 132-132
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@Packages/src/Documentation`~/tools.md at line 26, Update the three remaining
fenced code blocks in tools.md, including the blocks near the referenced
locations, to specify an appropriate language identifier such as text. Preserve
each block’s existing content while adding the identifiers needed to satisfy
markdownlint MD040.
Source: Linters/SAST tools
| → simulate-mouse-ui (Action: DragMove, X: 200, Y: 400, DragSpeed: 300) | ||
| → simulate-mouse-ui (Action: DragEnd, X: 400, Y: 300) | ||
| ``` | ||
| https://github.com/user-attachments/assets/c7ee9103-c282-4f90-8b01-64bb17400f3e |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Embed the screenshot instead of exposing only its asset URL.
The standalone attachment URL renders as a link in Markdown, so the captured image is not shown in the tool reference. Use image syntax with descriptive alt text, for example .
🤖 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 `@Packages/src/Documentation`~/tools.md at line 155, Replace the standalone
attachment URL in the tools documentation with Markdown image syntax, using
descriptive alt text such as “Mouse UI example” and preserving the existing
asset URL as the image source.
The previous logo.png was a 1080x720 crop; the final art direction settled on a 720x720 square with even black padding around the CRT.
Choosing --project-path is something the AI agent handles on its own, so the README does not need to teach it to human readers.
"dispatcher" is only defined later in the How It Works section, so the install paragraph now just says the uloop command is placed on PATH.
Requiring Unity is self-evident for a Unity package, and the "Node.js no longer required" news already lives in whats-new-v3.
Which package enables which tool is reference detail, not something a reader needs before installing; the tools themselves guide users when the optional package is missing.
The one-block design was only mentioned in passing inside the security note, so readers could still assume line-by-line execution. State it explicitly right before each command block instead.
The art direction moved from black lettering on a lit CRT screen to light lettering on a dark screen, matching the album-art mood better.
Alongside pause-point, V3's other headline is reliability: connections stay stable with Unity in the background (focus suppression plus the runInBackground override during CLI-driven PlayMode, and wall-clock timers independent of Editor update callbacks) and across parallel Editors (one Unix socket / named pipe per project, no port collisions). State it in the README summary line and the whats-new intro.
700px screenshots dominated the quickstart flow; 350px keeps them legible while letting the surrounding text stay in view.
The auto-scan was sped up and the wizard window now opens immediately (#1923, #1931, #1955), so a dedicated "wait for the scan" step with the polling explanation no longer reflects reality. Keep the auto-open, screenshot, status quote, and manual-open fallback inside the Migrate step, renumber the later steps, and replace the literal 36 in the quoted status with the {N} placeholder used elsewhere.
The settings file is UserSettings/UnityCliLoopSettings.json. The UnityMcpSettings.json name only survives as a migration source that the package reads once and then deletes, so documenting it as the live file misdirected readers writing .gitignore rules.
Replace the reference screen lettering with the project logo while preserving the pale CRT palette, analog texture, and chromatic edge bleed.
Contributor
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 (2)
Packages/src/Documentation~/migration-v2-to-v3.md (1)
145-146: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the stale command count.
The table contains eight commands, but this text says “The six commands.” Replace the count and range wording with “The commands listed below” so
get-versionandget-project-infoare covered clearly.Proposed wording
-The six commands from `capture-window` through `get-menu-items` were already removed or renamed during V2's lifetime and do not exist in the final V2 release. +The commands listed below were already removed or renamed during V2's lifetime and do not exist in the final V2 release.🤖 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 `@Packages/src/Documentation`~/migration-v2-to-v3.md around lines 145 - 146, Update the migration documentation paragraph to replace the inaccurate “six commands from capture-window through get-menu-items” wording with “The commands listed below,” while preserving the existing explanation about commands removed or renamed during V2.README_ja.md (1)
296-297: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRestore the
--project-pathguidance that was removed.
uloop --project-path <path>is still a supported global option and is printed by--help, butREADME_ja.mdnow only mentionsuloop launch/compile/get-logswithout explaining when to run from the project directory and when to pass--project-path <path>. Add back that brief usage example.🤖 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_ja.md` around lines 296 - 297, Restore the missing --project-path usage guidance in the README_ja.md “仕組み” section, including a brief example that distinguishes running commands from the project directory from passing --project-path <path>. Cover the supported uloop launch, compile, and get-logs commands without changing unrelated documentation.
🤖 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 `@Packages/src/Documentation`~/migration-v2-to-v3.md:
- Around line 145-146: Update the migration documentation paragraph to replace
the inaccurate “six commands from capture-window through get-menu-items” wording
with “The commands listed below,” while preserving the existing explanation
about commands removed or renamed during V2.
In `@README_ja.md`:
- Around line 296-297: Restore the missing --project-path usage guidance in the
README_ja.md “仕組み” section, including a brief example that distinguishes running
commands from the project directory from passing --project-path <path>. Cover
the supported uloop launch, compile, and get-logs commands without changing
unrelated documentation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 65b02c1b-98bc-4401-a4e6-6f8716e85254
⛔ Files ignored due to path filters (2)
Packages/src/Documentation~/images/logo-v2.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/logo.pngis excluded by!**/*.pngand included by none
📒 Files selected for processing (6)
Packages/src/Documentation~/migration-v2-to-v3.mdPackages/src/Documentation~/migration-v2-to-v3_ja.mdPackages/src/Documentation~/whats-new-v3.mdPackages/src/Documentation~/whats-new-v3_ja.mdREADME.mdREADME_ja.md
🚧 Files skipped from review as they are similar to previous changes (2)
- Packages/src/Documentation~/whats-new-v3.md
- README.md
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
4 issues found and verified against the latest diff
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="Packages/src/Documentation~/migration-v2-to-v3.md">
<violation number="1" location="Packages/src/Documentation~/migration-v2-to-v3.md:34">
P2: The new migration screenshots appear to be empty/placeholder files: each of the four referenced PNGs is only 95 bytes, so they will render as blank or 1x1 images rather than the captured screenshots this change is meant to add. Verify the real captured images were committed and that they render the detected/confirm/skill states correctly.</violation>
</file>
<file name="Packages/src/Documentation~/whats-new-v3.md">
<violation number="1" location="Packages/src/Documentation~/whats-new-v3.md:13">
P3: This change re-describes the upgrade as "three steps" (adding Install/Update Skills), but the migration guide this very sentence links to (`migration-v2-to-v3.md`) still says the upgrade is "just two steps ... You are done — you can stop reading here." A reader who follows the pointer now sees conflicting instructions depending on which page they open. Consider updating the matching step description in the migration guide (and its Japanese counterpart) to include the Install Skills step so the two documents stay consistent.</violation>
</file>
<file name="Packages/src/Documentation~/tools.md">
<violation number="1" location="Packages/src/Documentation~/tools.md:155">
P2: The screenshot for the simulate-mouse-ui section is added as a bare URL on its own line instead of Markdown image syntax, so it will render as plain link text and the intended screenshot won't display. This also contradicts the PR note claiming no user-attachments URLs remain in the English docs. Wrap it as an image, e.g. ``.</violation>
</file>
<file name="README.md">
<violation number="1" location="README.md:81">
P3: The list of commands owned by the v3 dispatcher no longer mentions `completion`, but the dispatcher still handles it in every project as a no-op stub to keep stale shell `eval "$(uloop completion ...)"` hooks working (see cli/dispatcher/internal/dispatcher/completion.go and its routing test, which runs the stub in the dispatcher process without a project pin). Dropping it from the owned list makes the sentence technically incomplete — a reader could conclude `completion` is delegated to the v2 CLI, which is not the case. Consider restoring the short mention (e.g. '... `launch`, and `completion` (a no-op stub for shell-hook back-compat) commands ...').</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
|
|
||
| > 📸 **SCREENSHOT NEEDED** — `images/migration-safe-mode-dialog.png` | ||
| > Unity's Safe Mode confirmation dialog shown on startup, with the `Ignore` button visible. | ||
|  |
There was a problem hiding this comment.
P2: The new migration screenshots appear to be empty/placeholder files: each of the four referenced PNGs is only 95 bytes, so they will render as blank or 1x1 images rather than the captured screenshots this change is meant to add. Verify the real captured images were committed and that they render the detected/confirm/skill states correctly.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At Packages/src/Documentation~/migration-v2-to-v3.md, line 34:
<comment>The new migration screenshots appear to be empty/placeholder files: each of the four referenced PNGs is only 95 bytes, so they will render as blank or 1x1 images rather than the captured screenshots this change is meant to add. Verify the real captured images were committed and that they render the detected/confirm/skill states correctly.</comment>
<file context>
@@ -31,8 +31,7 @@ On startup, Unity finds the compile errors from the V2 sources and asks whether
-> 📸 **SCREENSHOT NEEDED** — `images/migration-safe-mode-dialog.png`
-> Unity's Safe Mode confirmation dialog shown on startup, with the `Ignore` button visible.
+
> [!WARNING]
</file context>
| → simulate-mouse-ui (Action: DragMove, X: 200, Y: 400, DragSpeed: 300) | ||
| → simulate-mouse-ui (Action: DragEnd, X: 400, Y: 300) | ||
| ``` | ||
| https://github.com/user-attachments/assets/c7ee9103-c282-4f90-8b01-64bb17400f3e |
There was a problem hiding this comment.
P2: The screenshot for the simulate-mouse-ui section is added as a bare URL on its own line instead of Markdown image syntax, so it will render as plain link text and the intended screenshot won't display. This also contradicts the PR note claiming no user-attachments URLs remain in the English docs. Wrap it as an image, e.g. .
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At Packages/src/Documentation~/tools.md, line 155:
<comment>The screenshot for the simulate-mouse-ui section is added as a bare URL on its own line instead of Markdown image syntax, so it will render as plain link text and the intended screenshot won't display. This also contradicts the PR note claiming no user-attachments URLs remain in the English docs. Wrap it as an image, e.g. ``.</comment>
<file context>
@@ -0,0 +1,216 @@
+→ simulate-mouse-ui (Action: DragMove, X: 200, Y: 400, DragSpeed: 300)
+→ simulate-mouse-ui (Action: DragEnd, X: 400, Y: 300)
+```
+https://github.com/user-attachments/assets/c7ee9103-c282-4f90-8b01-64bb17400f3e
+
+### 13. simulate-mouse-input - Simulate Mouse Input in PlayMode via Input System
</file context>
Suggested change
| https://github.com/user-attachments/assets/c7ee9103-c282-4f90-8b01-64bb17400f3e | |
|  |
| ## Upgrading | ||
|
|
||
| For most users the upgrade is two steps: raise the Unity package version, then open `Window > Unity CLI Loop > Settings` and press **Install CLI** (or **Update CLI**) to replace the old npm CLI with the native dispatcher. The installer attempts to remove the obsolete npm package with `npm uninstall -g uloop-cli` and prints the command to run manually when it cannot. | ||
| For most users the upgrade is three steps. Raise the Unity package version, open `Window > Unity CLI Loop > Settings` and press **Install CLI** (or **Update CLI**) to replace the old npm CLI with the native `uloop` command, and finally press **Install Skills** (or **Update Skills**) in the same window to refresh your installed Skills to the V3 content. The installer attempts to remove the obsolete npm package with `npm uninstall -g uloop-cli` and prints the command to run manually when it cannot. |
There was a problem hiding this comment.
P3: This change re-describes the upgrade as "three steps" (adding Install/Update Skills), but the migration guide this very sentence links to (migration-v2-to-v3.md) still says the upgrade is "just two steps ... You are done — you can stop reading here." A reader who follows the pointer now sees conflicting instructions depending on which page they open. Consider updating the matching step description in the migration guide (and its Japanese counterpart) to include the Install Skills step so the two documents stay consistent.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At Packages/src/Documentation~/whats-new-v3.md, line 13:
<comment>This change re-describes the upgrade as "three steps" (adding Install/Update Skills), but the migration guide this very sentence links to (`migration-v2-to-v3.md`) still says the upgrade is "just two steps ... You are done — you can stop reading here." A reader who follows the pointer now sees conflicting instructions depending on which page they open. Consider updating the matching step description in the migration guide (and its Japanese counterpart) to include the Install Skills step so the two documents stay consistent.</comment>
<file context>
@@ -2,32 +2,25 @@
## Upgrading
-For most users the upgrade is two steps: raise the Unity package version, then open `Window > Unity CLI Loop > Settings` and press **Install CLI** (or **Update CLI**) to replace the old npm CLI with the native dispatcher. The installer attempts to remove the obsolete npm package with `npm uninstall -g uloop-cli` and prints the command to run manually when it cannot.
+For most users the upgrade is three steps. Raise the Unity package version, open `Window > Unity CLI Loop > Settings` and press **Install CLI** (or **Update CLI**) to replace the old npm CLI with the native `uloop` command, and finally press **Install Skills** (or **Update Skills**) in the same window to refresh your installed Skills to the V3 content. The installer attempts to remove the obsolete npm package with `npm uninstall -g uloop-cli` and prints the command to run manually when it cannot.
-The new dispatcher is also compatible with V2 projects. When a project still resolves to the V2 package, the dispatcher fetches the matching V2 CLI automatically and delegates the command to it — so replacing the CLI first does not break the V2 projects you still have around.
</file context>
| Keep the v3 dispatcher installed when working with both v2 and v3 projects. If Unity resolves a project to a v2 `io.github.hatayama.uloopmcp` package, the dispatcher automatically installs the matching v2 `uloop-cli` release into its versioned user cache and delegates the command to it. The resolved package version takes precedence over a stale v3 project-runner pin left after a downgrade. The initial npm installation and the v2-mode notice are written to stderr so stdout remains the delegated command's output. V3 projects continue to use the project runner selected by their pin. | ||
|
|
||
| The global `install`, `update`, `uninstall`, `completion` (now a no-op stub; shell completion has been removed), and `launch` commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects. | ||
| The global `install`, `update`, `uninstall`, and `launch` commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects. |
There was a problem hiding this comment.
P3: The list of commands owned by the v3 dispatcher no longer mentions completion, but the dispatcher still handles it in every project as a no-op stub to keep stale shell eval "$(uloop completion ...)" hooks working (see cli/dispatcher/internal/dispatcher/completion.go and its routing test, which runs the stub in the dispatcher process without a project pin). Dropping it from the owned list makes the sentence technically incomplete — a reader could conclude completion is delegated to the v2 CLI, which is not the case. Consider restoring the short mention (e.g. '... launch, and completion (a no-op stub for shell-hook back-compat) commands ...').
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 81:
<comment>The list of commands owned by the v3 dispatcher no longer mentions `completion`, but the dispatcher still handles it in every project as a no-op stub to keep stale shell `eval "$(uloop completion ...)"` hooks working (see cli/dispatcher/internal/dispatcher/completion.go and its routing test, which runs the stub in the dispatcher process without a project pin). Dropping it from the owned list makes the sentence technically incomplete — a reader could conclude `completion` is delegated to the v2 CLI, which is not the case. Consider restoring the short mention (e.g. '... `launch`, and `completion` (a no-op stub for shell-hook back-compat) commands ...').</comment>
<file context>
@@ -63,39 +65,50 @@ Scope(s): io.github.hatayama.uloopmcp
Keep the v3 dispatcher installed when working with both v2 and v3 projects. If Unity resolves a project to a v2 `io.github.hatayama.uloopmcp` package, the dispatcher automatically installs the matching v2 `uloop-cli` release into its versioned user cache and delegates the command to it. The resolved package version takes precedence over a stale v3 project-runner pin left after a downgrade. The initial npm installation and the v2-mode notice are written to stderr so stdout remains the delegated command's output. V3 projects continue to use the project runner selected by their pin.
-The global `install`, `update`, `uninstall`, `completion` (now a no-op stub; shell completion has been removed), and `launch` commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects.
+The global `install`, `update`, `uninstall`, and `launch` commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects.
V2 delegation requires Node.js 22 or later, including npm for the first command that populates the cache. Do not press **Update CLI** or **Downgrade CLI** in a v2 project's Settings window. These buttons are normally hidden because the delegated CLI reports the matching v2 version, but using one can restore a global npm CLI that hides the v3 dispatcher depending on PATH order.
</file context>
Suggested change
| The global `install`, `update`, `uninstall`, and `launch` commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects. | |
| The global `install`, `update`, `uninstall`, `launch`, and `completion` (now a no-op stub for shell-hook back-compat) commands remain owned by the v3 dispatcher in every project. Other project commands, help, and the project-scoped version request are delegated for detected v2 projects. |
v3-beta gained the terminal package install (uloop package install) and the pin-trusting one-liner installer while this branch was rewriting the English docs, so both READMEs conflicted in the install section. Resolution: take v3-beta's install documentation verbatim in both languages. Its one-liner (curl | sh, irm | iex) replaces the gh/jq bootstrap as the primary path, which also retires this branch's "paste the whole block" guidance -- that advice existed only because the old flow was a multi-line block. The manual attestation-verified install survives as v3-beta wrote it, with an explicit release tag. Everything outside the install section keeps this branch's version: the restructured English README, the tool/custom-tool reference pages, the corrected settings file name, the 350px screenshots, and the skills count of 18.
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
118-135: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winAlign the manual attestation release source between README files.
README.mddocuments choosing a release and defaults the example torefs/heads/v3-beta, whileREADME_ja.mddefaults auto-resolved releases torefs/heads/main. Use a consistent channel/source ref for each release type across both manuals.🤖 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 118 - 135, The manual attestation instructions use inconsistent source refs between the English and Japanese README files. Align README.md lines 118-135 and README_ja.md lines 133-145 so each release type uses the same source ref across both manuals, preserving the main-release and v3-beta mappings.
🤖 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.
Nitpick comments:
In `@README.md`:
- Around line 118-135: The manual attestation instructions use inconsistent
source refs between the English and Japanese README files. Align README.md lines
118-135 and README_ja.md lines 133-145 so each release type uses the same source
ref across both manuals, preserving the main-release and v3-beta mappings.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 803d0b24-3866-458d-a2ba-8acfa3ca0e66
⛔ Files ignored due to path filters (7)
Packages/src/Documentation~/images/logo.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/migration-safe-mode-dialog.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/migration-wizard-confirm-dialog.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/migration-wizard-detected.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/settings-cli-installed.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/settings-cli-not-installed.pngis excluded by!**/*.pngand included by nonePackages/src/Documentation~/images/settings-skills-install.pngis excluded by!**/*.pngand included by none
📒 Files selected for processing (2)
README.mdREADME_ja.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User Impact
.claude/rules/cli.mdlink, and no explanation of the Claude Code sandbox configuration or the dispatcher/runner architecturetools.md/custom-tools.mdreference pagesChanges
README.md: full rewrite mirroring the reviewed Japanese README — new CRT logo with the corrected Human After All credit, What's New / migration links up top, hands-on feature verification in the concept, no-Node.js note, auto tag resolution in the terminal install, Settings window screenshots, pause-point skill row, Claude Code sandbox section, How It Works section, and extraction of the tool/custom-tool details (stale link tip and the Go CLI contributor section removed)whats-new-v3.md: three-paragraph intro without the Highlights section, three-step upgrade including Install Skills,--dry-runnote, and the Removed list trimmed to changes actually made since the last V2 releasemigration-v2-to-v3.md: five screenshot placeholders replaced with the four captured images (overview and detected states share one image, since the auto-opened wizard already shows the detection status), plus a note that six listed commands were already gone in the final V2 releasetools.md,custom-tools.md: new English counterparts of the extracted Japanese reference pagesREADME_ja.md: correct the bundled skills count to 18 (the 19th directory under.claude/skillsis the HelloWorld sample from this development project)Verification
grepconfirmed noSCREENSHOT NEEDEDplaceholders, stale.claude/rules/cli.mdreferences, or old user-attachments screenshot URLs remain in the English docstools.md,custom-tools.md,#step-1-install-the-cli,#custom-skills-for-your-tools)git diffagainstv3-betacontains only the English sync and the skills-count fixRelease reminder