docs(#6243): broaden doc-update rule to cover behavior and format changes - #6245
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#6243): broaden doc-update rule to cover behavior and format changes#6245fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
…nges
Amend the existing AGENTS.md doc-update rule to trigger on behavior
and output format changes, not just removals and renames. The prior
wording ("removing or renaming") missed cases where a code agent
changed CLI output format (e.g., PR #6239 changed the repos status
REF column format without updating docs/cli/repos.md). The review
agent caught the stale doc, but the code agent should have grepped
docs proactively.
The updated rule now reads: "When removing, renaming, or changing
the behavior or output format of a CLI command, public API, or
user-facing feature, grep all documentation files under docs/ for
references and update them to reflect the current behavior."
Closes #6243
|
🤖 Finished Review · ✅ Success · Started 11:24 PM UTC · Completed 11:36 PM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Labels: PR is a pure documentation change to AGENTS.md governance file |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
| - Never commit secrets (tokens, API keys, PEM keys, gcloud credentials) or sensitive data (GCP project names, service account identifiers, Model Armor template names, internal hostnames). Use environment variables with no defaults for sensitive values. | ||
| - When adding a new doc under `docs/`, check `docs/.vitepress/config.ts` sidebar config. Sections using `getMarkdownFiles()` are auto-discovered. All other sections need a manual `{ text, link }` entry. Also add the new folder's prefix to `search.options.scopes` in the same file so the folder's pages are reachable when search scope pills are active. | ||
| - When removing or renaming a CLI command, public API, or user-facing feature, grep all documentation files under `docs/` for references to the old name and update or remove them. Pay special attention to `docs/cli/`, `docs/guides/`, and any getting-started or operations guides that walk through the removed workflow. | ||
| - When removing, renaming, or changing the behavior or output format of a CLI command, public API, or user-facing feature, grep all documentation files under `docs/` for references and update them to reflect the current behavior. Pay special attention to `docs/cli/`, `docs/guides/`, and any getting-started or operations guides. |
There was a problem hiding this comment.
[medium] protected-path
This PR modifies AGENTS.md, which is a protected governance file. The change is well-justified by issue #6243 (broadening the doc-update rule to also cover behavior and output format changes, motivated by a concrete gap identified in PR #6239). Human approval is always required for protected-path changes, regardless of justification.
fullsend-ai-review
Bot
added
requires-manual-review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Broadens the AGENTS.md doc-update rule to trigger when a code agent changes the behavior or output format of a CLI command, public API, or user-facing feature — not just when removing or renaming one. This prevents stale documentation from reaching review, as happened in PR #6239 where the REF column format changed but
docs/cli/repos.mdwas not updated.Changes
Testing
Checklist
!for breaking changes)Closes #6243
Post-script verification
agent/6243-broaden-doc-update-rule)f7b794dca167e312fda418b0fd92aa60db00987a..HEAD)