Skip to content

docs(#5848): add CLI flag documentation sync rule to AGENTS.md - #5850

Merged
rh-hemartin merged 1 commit into
mainfrom
agent/5848-agents-cli-docs-guidance
Aug 27, 2026
Merged

docs(#5848): add CLI flag documentation sync rule to AGENTS.md#5850
rh-hemartin merged 1 commit into
mainfrom
agent/5848-agents-cli-docs-guidance

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

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 in docs/cli/ and search docs/guides/ for tables or descriptions referencing the same flag.

Related Issue

Closes #5848

Changes

  • Added a bullet point to the "How to work in this repo" section of AGENTS.md instructing contributors to update docs/cli/ and search docs/guides/ when modifying CLI flags in internal/cli/

Testing

  • make lint-md-links passes — no broken links
  • No code changes; no test updates needed

Checklist

  • PR title follows Conventional Commits (correct type, ! for breaking changes)
  • Documentation-only change — no functional code modified

Closes #5848

Post-script verification

  • Branch is not main/master (agent/5848-agents-cli-docs-guidance)
  • Secret scan passed (gitleaks — 0251e7d777197981831f6713c44a53ca9a4e20f7..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 3, 2026 07:14
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Aug 3, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 3, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:16 AM UTC · Completed 7:26 AM UTC
Commit: b74324a · View workflow run →

@codecov

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium


Labels: PR is a single-line documentation change to AGENTS.md governance file

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review comment for full details.

Comment thread AGENTS.md
@rh-hemartin

Copy link
Copy Markdown
Member

/fs-fix rebase

@fullsend-ai-coder

fullsend-ai-coder Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

🤖 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: b74324a · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.37

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

⚠️ Post-fix script failed — Secret scan blocked (exit code 1)

The fix agent completed, but the post-fix script failed before finishing.

Workflow run: https://github.com/fullsend-ai/fullsend/actions/runs/32941415827

Details:
Secret scan blocked the push. See workflow logs for details.
Please check the workflow logs for full details and retry with /fs-fix if appropriate.

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
@rh-hemartin
rh-hemartin force-pushed the agent/5848-agents-cli-docs-guidance branch from b74324a to 9ac44a5 Compare August 27, 2026 06:50
@rh-hemartin
rh-hemartin enabled auto-merge August 27, 2026 06:50
@rh-hemartin
rh-hemartin added this pull request to the merge queue Aug 27, 2026
Merged via the queue into main with commit 34513c3 Aug 27, 2026
28 checks passed
@rh-hemartin
rh-hemartin deleted the agent/5848-agents-cli-docs-guidance branch August 27, 2026 06:51
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 27, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 6:52 AM UTC · Completed 7:03 AM UTC

Commit: 9ac44a5 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.14

@fullsend-ai-review

Copy link
Copy Markdown

Review skipped — this PR is already merged.

The /fs-review command only reviews open PRs/MRs.

Posted by fullsend pre-review check

@fullsend-ai-retro

fullsend-ai-retro Bot commented Aug 27, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 6:53 AM UTC · Completed 7:01 AM UTC

Commit: 9ac44a5 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.71

@fullsend-ai-retro

Copy link
Copy Markdown

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 docs/cli/ pages), filed #5848, and the code agent produced a correct 1-line AGENTS.md change in a single attempt. The review agent correctly flagged AGENTS.md as a protected governance file requiring human approval.

The only friction point was the fix agent's post-fix script failure. On Aug 26, a human requested /fs-fix rebase to resolve a stale branch. The fix agent (claude-opus-4-6, ~$1.37) successfully rebased and resolved the AGENTS.md merge conflict, but the post-fix gitleaks scan scanned 939 commits and detected 6 leaks — all false positives from upstream main history pulled into the scan range by the rebase. The human had to manually force-push the rebased commit and merge it the next day.

This scan-range expansion after rebase is a known bug, already tracked in #6259 and agents#318. PR #5850 provides additional evidence: the PRE_AGENT_HEAD..HEAD range included all upstream commits after the rebase, causing gitleaks detect to flag test fixtures in the main branch history. The fix proposed in agents#318 (use merge-base to compute the scan range after rebase) would have prevented this failure.

No new proposals — the workflow was otherwise clean, and the single failure is well-covered by existing issues.

@fullsend-ai-review

Copy link
Copy Markdown

Review skipped — this PR is already merged.

The /fs-review command only reviews open PRs/MRs.

Posted by fullsend post-review check

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

Labels

documentation ready-for-review Triggers review agent dispatch requires-manual-review Review requires human judgment Review effort 1/5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS.md: add guidance to update docs/cli/ when changing CLI flag behavior

1 participant