docs(#5848): add CLI flag documentation sync rule to AGENTS.md - #5850
Conversation
|
🤖 Finished Review · ✅ Success · Started 7:16 AM UTC · Completed 7:26 AM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Labels: PR is a single-line documentation change to AGENTS.md governance file |
|
/fs-fix rebase |
|
🤖 Finished Fix · ❌ Failure (post-script /home/runner/work/fullsend/fullsend/.fullsend/.fullsend-cache/resources/sha256/1704f826be06352c5aa727ca7a68e6bc3db1837e9743e1727323664169eefe2b/scripts/post-fix.sh failed: exit status 1) · Started 7:11 AM UTC · Completed 7:17 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.37 |
|
The fix agent completed, but the post-fix script failed before finishing. Workflow run: https://github.com/fullsend-ai/fullsend/actions/runs/32941415827 Details: |
CLI reference pages under docs/cli/ are manually maintained and silently drift when flag help text, defaults, or behavior change in internal/cli/. PR #5763 demonstrated this: the code agent updated a flag's help text but missed the corresponding docs, requiring a review-fix cycle. Add a bullet to AGENTS.md's "How to work in this repo" section instructing contributors to update docs/cli/ and search docs/guides/ when modifying CLI flags. This follows the same pattern as the interface documentation sync rule added in #5307. Closes #5848
b74324a to
9ac44a5
Compare
|
🤖 Finished Review · ✅ Success · Started 6:52 AM UTC · Completed 7:03 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.14 |
|
Review skipped — this PR is already merged. The Posted by fullsend pre-review check |
|
🤖 Finished Retro · ✅ Success · Started 6:53 AM UTC · Completed 7:01 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.71 |
|
Retro: PR #5850 — add CLI flag documentation sync rule to AGENTS.md This PR was generated end-to-end by the agent pipeline: the retro agent on PR #5763 identified a gap (code agent updated CLI flag help text but didn't update manually-maintained The only friction point was the fix agent's post-fix script failure. On Aug 26, a human requested This scan-range expansion after rebase is a known bug, already tracked in #6259 and agents#318. PR #5850 provides additional evidence: the No new proposals — the workflow was otherwise clean, and the single failure is well-covered by existing issues. |
|
Review skipped — this PR is already merged. The Posted by fullsend post-review check |
Summary
Adds AGENTS.md guidance for keeping CLI reference documentation in sync with CLI flag changes. When modifying CLI flag help text, defaults, or behavior in
internal/cli/, contributors are now instructed to update the corresponding page indocs/cli/and searchdocs/guides/for tables or descriptions referencing the same flag.Related Issue
Closes #5848
Changes
docs/cli/and searchdocs/guides/when modifying CLI flags ininternal/cli/Testing
make lint-md-linkspasses — no broken linksChecklist
!for breaking changes)Closes #5848
Post-script verification
agent/5848-agents-cli-docs-guidance)0251e7d777197981831f6713c44a53ca9a4e20f7..HEAD)