Fix README structural issues, stale tool names, and typo - #570
Open
Mr-Nilarnab wants to merge 1 commit into
Open
Fix README structural issues, stale tool names, and typo#570Mr-Nilarnab wants to merge 1 commit into
Mr-Nilarnab wants to merge 1 commit into
Conversation
docs: fix broken README structure, stale tool names, and typo - Restore the orphaned command list under "Handling Long-Running Commands" — it had drifted down to the end of the unrelated "Using Different Shells" section, leaving its own section with just an intro line and no content. - Update outdated tool names (execute_command, read_output) to start_process and read_process_output in that list and in the "Using Different Shells" examples, matching the current Available Tools table. - Add the missing "## Contributing" heading. The TOC already linked to #contributing, but the section had no heading to anchor to. - Remove the dead TOC entry "Work in Progress and TODOs" (#roadmap), which pointed to a section that doesn't exist anywhere in the doc. - Fix typo "hundereds" -> "hundreds" in a testimonial quote. No functional/link changes. The testemonials/ folder name (missing an "i") used throughout the raw.githubusercontent.com image URLs was intentionally left as-is since correcting it would break existing links to real assets in the repo.
Contributor
📝 WalkthroughWalkthroughREADME installation guidance, command usage examples, navigation, testimonial content, and contribution documentation were updated. No exported or public entities changed. ChangesREADME documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Suggested reviewers: 🚥 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: 2
🤖 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 1072-1073: Correct the remaining typo in the testimonial image alt
text by changing “much more thank you” to the intended wording, such as “much
more than code editing—thank you.”
- Around line 929-935: Update every start_process example in the README,
including the default, zsh, and bash variants, to include a numeric timeout_ms
property in each argument payload, consistent with the required
StartProcessArgsSchema.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+929
to
+935
| start_process({ "command": "echo $SHELL" }) | ||
|
|
||
| // Using zsh specifically | ||
| execute_command({ "command": "echo $SHELL", "shell": "/bin/zsh" }) | ||
| start_process({ "command": "echo $SHELL", "shell": "/bin/zsh" }) | ||
|
|
||
| // Using bash specifically | ||
| execute_command({ "command": "echo $SHELL", "shell": "/bin/bash" }) | ||
| start_process({ "command": "echo $SHELL", "shell": "/bin/bash" }) |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Include the required timeout_ms in every start_process example.
StartProcessArgsSchema requires timeout_ms, so these examples will be rejected as invalid arguments. Add a numeric timeout to each payload.
Proposed fix
-start_process({ "command": "echo $SHELL" })
+start_process({ "command": "echo $SHELL", "timeout_ms": 10000 })
-start_process({ "command": "echo $SHELL", "shell": "/bin/zsh" })
+start_process({ "command": "echo $SHELL", "shell": "/bin/zsh", "timeout_ms": 10000 })
-start_process({ "command": "echo $SHELL", "shell": "/bin/bash" })
+start_process({ "command": "echo $SHELL", "shell": "/bin/bash", "timeout_ms": 10000 })📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| start_process({ "command": "echo $SHELL" }) | |
| // Using zsh specifically | |
| execute_command({ "command": "echo $SHELL", "shell": "/bin/zsh" }) | |
| start_process({ "command": "echo $SHELL", "shell": "/bin/zsh" }) | |
| // Using bash specifically | |
| execute_command({ "command": "echo $SHELL", "shell": "/bin/bash" }) | |
| start_process({ "command": "echo $SHELL", "shell": "/bin/bash" }) | |
| start_process({ "command": "echo $SHELL", "timeout_ms": 10000 }) | |
| // Using zsh specifically | |
| start_process({ "command": "echo $SHELL", "shell": "/bin/zsh", "timeout_ms": 10000 }) | |
| // Using bash specifically | |
| start_process({ "command": "echo $SHELL", "shell": "/bin/bash", "timeout_ms": 10000 }) |
🤖 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 929 - 935, Update every start_process example in the
README, including the default, zsh, and bash variants, to include a numeric
timeout_ms property in each argument payload, consistent with the required
StartProcessArgsSchema.
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
Cleans up a few structural inconsistencies in the README that had likely crept in from past edits — no functional changes to the project itself, just documentation fixes.
Changes
Restored orphaned content: The numbered list belonging to "Handling Long-Running Commands" had been left stranded at the end of the unrelated "Using Different Shells" section, leaving its own section with just an intro line and no actual content. Moved it back to where it belongs.
Updated stale tool names: That list (and the "Using Different Shells" code examples) referenced
execute_commandandread_output, which don't exist in the current Available Tools table. Updated them tostart_processandread_process_outputfor consistency.Added missing
## Contributingheading: The Table of Contents already linked to#contributing, but there was no heading for it to anchor to — the contributing text was just floating under Testimonials.Removed dead TOC link: "Work in Progress and TODOs" (
#roadmap) pointed to a section that doesn't exist anywhere in the document. Removed the link rather than invent placeholder content.Fixed typo: "losing hundereds of cascade tokens" → "hundreds" in a testimonial quote.
Notes
testemonials/(missing an "i") on GitHub. This is a real typo baked into the repo's actual file structure, but I left it untouched since correcting it in the doc would break the existing links to those assets. Happy to open a separate follow-up if you want to rename the folder itself.Testing
Summary by CodeRabbit