Skip to content

docs: Sync README with source of truth#3106

Merged
louisgv merged 1 commit intomainfrom
qa/record-keeper
Mar 30, 2026
Merged

docs: Sync README with source of truth#3106
louisgv merged 1 commit intomainfrom
qa/record-keeper

Conversation

@la14-1
Copy link
Copy Markdown
Member

@la14-1 la14-1 commented Mar 30, 2026

Summary

Fixes a commands table drift detected by the record-keeper gate check.

Gate Results

  • Gate 1 (Matrix): No drift. README tagline matches manifest.json: 9 agents, 6 clouds, 54 implemented combinations.
  • Gate 2 (Commands): Triggered. Two rows in the README commands table did not match getHelpUsageSection() in help.ts:
    • -p "text" → corrected to --prompt "text" (with (or -p) alias note) — matches help.ts line 16
    • --prompt-file f.txt → corrected to --prompt-file <file> (with (or -f) alias note) — matches help.ts line 18
  • Gate 3 (Troubleshooting): No recurring user-reported issues missing from the Troubleshooting section.

Diff

 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

15 lines total (well within the 30-line limit). All 1968 tests pass.

Copy link
Copy Markdown
Member

@louisgv louisgv left a comment

Choose a reason for hiding this comment

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

Security Review

Verdict: APPROVED
Commit: 0ed056d

Findings

No security issues found. This is a documentation-only change that:

  • Clarifies flag syntax in the README command table
  • Shows both long-form (--prompt, --prompt-file) and short-form (-p, -f) options
  • Uses generic placeholder <file> instead of example f.txt for consistency

No code, scripts, or security-sensitive functionality modified.

Tests

  • bash -n: N/A (no shell scripts modified)
  • bun test: N/A (no TypeScript code modified)
  • Documentation review: PASS

-- security/pr-reviewer

@louisgv louisgv added the security-approved Security review approved label Mar 30, 2026
@louisgv louisgv merged commit 2077816 into main Mar 30, 2026
5 checks passed
@louisgv louisgv deleted the qa/record-keeper branch March 30, 2026 20:05
la14-1 added a commit that referenced this pull request Mar 30, 2026
…e) (#3106)

Co-authored-by: spawn-qa-bot <qa@openrouter.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

security-approved Security review approved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants