docs(#6469): expand doc-update trigger to cover adding new features - #6470
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#6469): expand doc-update trigger to cover adding new features#6470fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
The AGENTS.md doc-update rule only triggered on "removing, renaming, or changing" existing behavior, which left a gap for additions. When the code agent added FULLSEND_REVIEW_CLIENT_ID as a new repo variable in PR #6446, it did not search docs/ for related tables or lists to update, resulting in 3 stale-documentation review findings. Expand the trigger to include "adding" as a verb, explicitly call out configuration variables, flags, and environment variables as examples, and instruct agents to search for existing inventories or tables of similar items when adding new entries. Note: make lint could not run in the sandbox (pre-commit network restriction). The post-script runs lint authoritatively on the runner. Closes #6469
|
🤖 Finished Review · ✅ Success · Started 10:37 PM UTC · Completed 10:51 PM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Labels: PR modifies AGENTS.md governance documentation for contributor and agent behavior |
![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, 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. | ||
| - When adding, removing, renaming, or changing the behavior or output format of a CLI command, public API, or user-facing feature (including new configuration variables, flags, or environment variables), grep all documentation files under `docs/` for references to the affected feature area and update them to reflect the current behavior. For new additions, search for documentation tables or lists of similar items (e.g., repo variables, CLI flags) that should include the new entry. 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
AGENTS.md is a protected governance file. This PR modifies the doc-update trigger rule to expand the set of trigger verbs and clarify scope. The PR links to issue #6469 and provides clear rationale for the change. Human approval is always required for protected-path changes, regardless of context.
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
Expands the AGENTS.md doc-update trigger rule to explicitly cover adding new user-facing configuration (variables, flags, environment variables) to existing CLI commands. Previously, the rule only triggered on "removing, renaming, or changing" existing behavior, which the code agent reasonably interpreted as not covering additions — leading to missed documentation updates in PR #6446.
Related Issue
Changes
docs/cli/,docs/guides/, and operations guidesTesting
Checklist
!for breaking changes)Closes #6469
Post-script verification
agent/6469-expand-doc-update-trigger)6fa6cb907b700abaace905bf2cfd8ffb5693dc71..HEAD)