Skip to content

docs: fix nonexistent 'rrext_store get_all_projects' CLI example#1613

Open
nihalnihalani wants to merge 2 commits into
rocketride-org:developfrom
nihalnihalani:docs/fix-readme-store-cli-example
Open

docs: fix nonexistent 'rrext_store get_all_projects' CLI example#1613
nihalnihalani wants to merge 2 commits into
rocketride-org:developfrom
nihalnihalani:docs/fix-readme-store-cli-example

Conversation

@nihalnihalani

@nihalnihalani nihalnihalani commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

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 projects

This command does not exist:

  • The CLI (packages/client-python/src/rocketride/cli/main.py) registers the command as store, not rrext_storerrext_store is the underlying wire command name, not a CLI command.
  • The store command's only subcommands are dir, type, write, rm, mkdir, and stat; there is no get_all_projects subcommand.

Fix

Replace the line in both files with a real invocation, matching the ### store examples already documented in packages/docs/content-static/cli.mdx:

rocketride store dir /                       # List the root of the file store

(store dir takes an optional positional path, so store dir / is valid — it's the exact first example in cli.mdx.)

The ### store section in packages/docs/content-static/cli.mdx was checked and is already accurate; no changes needed there.

Test plan

  • Verified against upstream/develop that store (not rrext_store) is the registered CLI command and get_all_projects does not exist as a subcommand
  • git grep confirms these were the only two occurrences of the bogus example in the repo
  • Docs-only change; no code touched

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Python client CLI examples to replace the outdated project-listing command with rocketride store dir / for listing the root of the server file store.
    • Expanded the store command description to include its available sub-commands (dir, type, write, rm, mkdir, stat).

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>
@github-actions github-actions Bot added docs Documentation module:client-python Python SDK and MCP client labels Jul 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID and forum thread ID. Do not edit or delete.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: b5228dac-27c9-4ee9-8257-10c8553fad1a

📥 Commits

Reviewing files that changed from the base of the PR and between f324df7 and b008188.

📒 Files selected for processing (2)
  • docs/README-python-client.md
  • packages/client-python/docs/index.md

📝 Walkthrough

Walkthrough

Updated Python client CLI documentation to replace the stored-project listing example with rocketride store dir / and document the available store sub-commands.

Changes

CLI documentation

Layer / File(s) Summary
File-store CLI example
docs/README-python-client.md, packages/client-python/docs/index.md
Replaced the rrext_store get_all_projects example with rocketride store dir /, described it as listing the file-store root, and documented the store sub-commands.

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

Suggested reviewers: jmaionchi, stepmikhaylov, rod-christensen

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the docs fix and the incorrect CLI example being replaced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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

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.

❤️ Share

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

@dsapandora dsapandora left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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 store

This 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

  1. Consistent formatting
    • Ensure the bold/italic style matches other command lists (e.g., wrap the command in backticks or triple‑backtick blocks as appropriate).
  2. Add a small note
    • Consider adding a brief comment explaining that store dir / is an alias of store list /, to aid newcomers.

Overall, this PR is clean and straightforward. Great job keeping our docs accurate!

@nihalnihalani

Copy link
Copy Markdown
Contributor Author

@dsapandora Both suggestions checked against the CLI source (packages/client-python/src/rocketride/cli/main.py and cli/commands/store.py) before acting:

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. store dir / alias note — Verified the parser registration and StoreCommand handlers: the store subcommands are exactly dir, type, write, rm, mkdir, and stat, and no aliases= is used anywhere in the subparser setup. There is no store list subcommand — the only list in the CLI is the top-level rocketride list, which lists active tasks, not store contents. A note calling store dir / an alias of store list / would document another nonexistent command, which is the exact class of error this PR removes, so I've left it out. For newcomers, the full sub-command reference (with examples for all six) lives in the docs-site CLI page under ### store (packages/docs/content-static/cli.mdx).

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>
@nihalnihalani

Copy link
Copy Markdown
Contributor Author

Follow-up to the review suggestions, now applied in b008188:

Suggestion 2 (newcomer note) — implemented with corrected content. Since store list doesn't exist (the sub-commands are dir, type, write, rm, mkdir, stat — verified in cli/main.py and cli/commands/store.py), the note added under the CLI block in both files reads:

The store command's sub-commands are dir, type, write, rm, mkdir, and stat — run rocketride store --help for details.

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.

@nihalnihalani
nihalnihalani requested a review from dsapandora July 17, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation module:client-python Python SDK and MCP client

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants