Skip to content

docs(readme): point at the full command list instead of repeating it - #695

Merged
Mearman merged 1 commit into
mainfrom
docs/readme-cli-reference-pointer
Nov 3, 2026
Merged

Mearman merged 1 commit into
mainfrom
docs/readme-cli-reference-pointer

Conversation

@Mearman

@Mearman Mearman commented Nov 3, 2026

Copy link
Copy Markdown
Member

The README is loaded into every session as project instructions (it is also CLAUDE.md and AGENTS.md), and it held a second copy of the full command list that had drifted from docs/cli-reference.md: the doc already had flags the README lacked, such as identity set --credential-cache. The README now points at the doc's list, and the three commands only the README had (model explain, statusline, statusline keys) are added to the doc first, verbatim. README goes from about 34 KB to 23 KB.

Nothing in the tests reads the README; the docs/cli-reference.md#full-command-list anchor is the existing heading.

The README held a second copy of the command list that had already drifted from
docs/cli-reference.md, which lacks no flag the README had except three lines.
Those three (model explain, statusline, statusline keys) move into the doc,
and the README links to its anchor.
The file is loaded into every session as project instructions,
so the duplicate cost context in each of them.
@Mearman
Mearman marked this pull request as ready for review November 3, 2026 07:29
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review ⚠️ Failed 2026-11-03T07:29:45.143722Z
We couldn’t complete this review. Comment @codex security review to try again.
b68bdbb Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

This security review couldn’t start because the paying account has exhausted its Codex allowance and has insufficient available credits. The payer can check their balance and add credits in the Codex usage dashboard, then try again. If you do not manage the paying account, contact this repository's admins.

@Mearman
Mearman enabled auto-merge (rebase) November 3, 2026 07:30
@Mearman
Mearman merged commit 69b6dd6 into main Nov 3, 2026
35 checks passed
@Mearman
Mearman deleted the docs/readme-cli-reference-pointer branch November 3, 2026 07:33
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.

1 participant