Skip to content

docs: correct rtk gh api to intentional 0% passthrough - #3450

Open
AshSgDe29071999 wants to merge 2 commits into
rtk-ai:developfrom
AshSgDe29071999:docs/gh-api-passthrough-zero-savings
Open

docs: correct rtk gh api to intentional 0% passthrough#3450
AshSgDe29071999 wants to merge 2 commits into
rtk-ai:developfrom
AshSgDe29071999:docs/gh-api-passthrough-zero-savings

Conversation

@AshSgDe29071999

Copy link
Copy Markdown

Summary

rtk init wrote rtk gh api # Compact API responses (26%) into agent instruction files, but run_api is an intentional 0% passthrough so values are not destroyed.

Changes

  • Update the GitHub section emitted by rtk init (src/hooks/init.rs): drop the false 26% claim, note passthrough, and point at --jq / compressed gh repo view.
  • Align docs/usage/FEATURES.md savings table with 0% passthrough.

Closes #3448

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.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Comment thread src/hooks/init.rs
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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.
@AshSgDe29071999

Copy link
Copy Markdown
Author

Good call — removed gh api from the covered commands list in the rtk init GitHub section. The section header still notes that gh api is intentional 0% passthrough.

@AshSgDe29071999

Copy link
Copy Markdown
Author

@aeppling — confirmed: gh api is not listed in the covered commands block under the GitHub section of rtk init (only pr / run / issue / repo view). The section header still notes that gh api is intentional 0% passthrough, consistent with docs/usage/FEATURES.md.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs contradict implementation: rtk init claims gh api saves 26%, but run_api is intentional 0% passthrough

3 participants