docs: fix broken cookbook examples and doc drift - #167
Open
joshdholtz wants to merge 4 commits into
Open
Conversation
customers grant takes positional args, not --customer-id/--entitlement-id flags; 'customer list' isn't a command; entitlements create is promptless so --yes was dead weight; the refund note said the opposite of what the example shows. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
rc api, rc packages list, and rc capital setup all shipped without landing in the tree this file claims is the source of truth. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Store-state isn't Apple/Play-only since the server took over store rules. The Products row was missing update, push, and the prices commands the AI Toolkit section already references; Offerings was missing restore and delete. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
grant takes an entitlement ID, not a lookup key; set-attribute uses --set key=value; customers show requires the ID; charts prose names the real 'charts show' command; packages list only fetches the first page per offering, so stop claiming 'all'; the no-bulk-import bullet now carves out store-state plans, which are exactly that. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
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.
A docs accuracy pass, checked against the real command tree (
rc commands --json) and per-command schemas.Two cookbook examples didn't run at all:
customers grantwas shown with flags it doesn't have (it takes positional args), and one example usedcustomersingular. Also dropped a dead--yeson the promptlessentitlements createand unmangled the refund note so it says what the example shows.command-surface.md calls itself the source of truth but was missing three shipped commands:
rc api,rc packages list, andrc capital setup.The README still pitched store-state plans as Apple/Play-only, which stopped being true when the server took over store rules. Its command table was also missing
products update/push/prices— the prices commands are referenced elsewhere in the same README.🤖 Generated with Claude Code
Note
Low Risk
Markdown-only documentation corrections with no runtime, auth, or data-handling changes.
Overview
Documentation-only pass so examples and the command tree match what
rcactually ships (validated againstrc commands/ schemas).README expands the capability table: offerings gain
restore/delete, products documentupdate,push, andprices/prices set, and the experimental store-state section no longer implies Apple/Play-only support—the server picks supported stores and fields.docs/command-surface.mdfills gaps in the source-of-truth tree (rc api,rc packages list,rc capital setup), corrects chart invocation torc charts show <name>, and updates customer command signatures (showrequired ID,set-attributevia repeatable--set, grant positional args). The intentional-no-bulk-import note now carves out store-state CSV/JSON as the exception.docs/cookbook.mdfixes copy-paste examples:customers grantuses positional args,customers list(notcustomer), drops spurious--yesonentitlements create, and clarifies that subscription refunds are meant to prompt.Reviewed by Cursor Bugbot for commit cbec68a. Bugbot is set up for automated code reviews on this repo. Configure here.