docs: correct rtk gh api to intentional 0% passthrough - #3450
docs: correct rtk gh api to intentional 0% passthrough#3450AshSgDe29071999 wants to merge 2 commits into
Conversation
Closes rtk-ai#3448 rtk init was writing CLAUDE.md guidance that claimed ~26% savings for `rtk gh api`, but run_api is a deliberate passthrough. Document the real behavior and point agents at --jq / repo view for compression.
|
|
| Note: Git passthrough works for ALL subcommands, even those not explicitly listed. | ||
| ### GitHub (26-87% savings) | ||
| ### GitHub (repo/view/list compressed; `gh api` is 0% passthrough) |
There was a problem hiding this comment.
already explicit above, just don't list it in covered cmds
Keep the 0% passthrough note in the GitHub section header; do not list gh api among the compact covered commands.
|
Good call — removed |
|
@aeppling — confirmed: The only remaining blocker on this PR is the CLA check (pending at https://cla-assistant.io/rtk-ai/rtk?pullRequest=3450). That needs a browser sign-in from the contributor account; once signed, CLA Assistant should flip green and this should be ready to merge. |
Summary
rtk initwrotertk gh api # Compact API responses (26%)into agent instruction files, butrun_apiis an intentional 0% passthrough so values are not destroyed.Changes
rtk init(src/hooks/init.rs): drop the false 26% claim, note passthrough, and point at--jq/ compressedgh repo view.docs/usage/FEATURES.mdsavings table with 0% passthrough.Closes #3448