docs: fix nonexistent 'rrext_store get_all_projects' CLI example#1613
docs: fix nonexistent 'rrext_store get_all_projects' CLI example#1613nihalnihalani wants to merge 2 commits into
Conversation
The Python client README and client-python docs both showed 'rocketride rrext_store get_all_projects' in the CLI examples block, but no such command exists: the CLI registers the command as 'store' (rrext_store is the underlying wire command name), and its subcommands are dir, type, write, rm, mkdir, and stat — there is no 'get_all_projects' subcommand. Replace the line with 'rocketride store dir /', matching the store examples documented in packages/docs/content-static/cli.mdx. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
🤖 Internal: Discord sync markerAuto-managed by the Discord notification workflow. Stores the linked Discord message ID and forum thread ID. Do not edit or delete. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdated Python client CLI documentation to replace the stored-project listing example with ChangesCLI documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 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 |
dsapandora
left a comment
There was a problem hiding this comment.
Thank you for cleaning up the docs!
Summary
This PR corrects an outdated CLI example that mistakenly referred to a non‑existent command rrext_store get_all_projects. The only references were in two documentation files (docs/README-python-client.md and packages/client-python/docs/index.md). They have been replaced with the valid example:
rocketride store dir / # List the root of the file storeThis mirrors the first working example from the CLI docs, ensuring consistency across all documentation channels.
Findings
| File | Line | Issue |
|---|---|---|
docs/README-python-client.md |
554 | Incorrect CLI command (rrext_store get_all_projects) |
packages/client-python/docs/index.md |
636 | Same incorrect CLI command |
No code changes were required, so the risk of regressions is low.
Quality Checklist
- End‑to‑end – The change is purely docs‑only; runs unaffected by build/test pipeline.
- Regression – None (no logic touched).
- Cross‑platform – CLI example remains valid on all supported platforms.
- Feature guards / UX – Updated documentation improves user experience and reduces confusion.
- Testing – No new tests needed; docs are verified against existing examples.
Suggestions
- Consistent formatting
- Ensure the bold/italic style matches other command lists (e.g., wrap the command in backticks or triple‑backtick blocks as appropriate).
- Add a small note
- Consider adding a brief comment explaining that
store dir /is an alias ofstore list /, to aid newcomers.
- Consider adding a brief comment explaining that
Overall, this PR is clean and straightforward. Great job keeping our docs accurate!
|
@dsapandora Both suggestions checked against the CLI source ( 1. Consistent formatting — The changed line sits inside the same ```bash fenced block as the rest of the CLI examples in both files, with the trailing comment aligned to the block's existing column. No bold/italic styling is used in any of these command lists, so the formatting already matches the surrounding block. No change needed. 2. |
Review on rocketride-org#1613 suggested a newcomer-facing note for the store example. The suggested wording ('store dir / is an alias of store list /') is not accurate — no 'store list' subcommand or alias exists — so instead add a correct note under the CLI block in both files listing the six real sub-commands (dir, type, write, rm, mkdir, stat) and pointing to 'rocketride store --help'. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Follow-up to the review suggestions, now applied in b008188: Suggestion 2 (newcomer note) — implemented with corrected content. Since
This serves the same goal (orienting newcomers to the file-store commands) without documenting a nonexistent alias. Suggestion 1 (formatting) — no change needed, as detailed in the previous comment: the example line already sits in the same ```bash fenced block as the rest of the command list, and no bold/italic styling is used in these blocks. |
Summary
The Python client README (
docs/README-python-client.md) and the client-python docs (packages/client-python/docs/index.md) both list this line in their CLI examples block:rocketride rrext_store get_all_projects # List stored projectsThis command does not exist:
packages/client-python/src/rocketride/cli/main.py) registers the command asstore, notrrext_store—rrext_storeis the underlying wire command name, not a CLI command.storecommand's only subcommands aredir,type,write,rm,mkdir, andstat; there is noget_all_projectssubcommand.Fix
Replace the line in both files with a real invocation, matching the
### storeexamples already documented inpackages/docs/content-static/cli.mdx:rocketride store dir / # List the root of the file store(
store dirtakes an optional positional path, sostore dir /is valid — it's the exact first example in cli.mdx.)The
### storesection inpackages/docs/content-static/cli.mdxwas checked and is already accurate; no changes needed there.Test plan
upstream/developthatstore(notrrext_store) is the registered CLI command andget_all_projectsdoes not exist as a subcommandgit grepconfirms these were the only two occurrences of the bogus example in the repo🤖 Generated with Claude Code
Summary by CodeRabbit
rocketride store dir /for listing the root of the server file store.storecommand description to include its available sub-commands (dir,type,write,rm,mkdir,stat).