Repository navigation
DOCS-3152: Make AGENTS.md the single source of agent instructions - #3214
Merged
Merged
Conversation
👷 Deploy request for calico-docs-preview-next pending review.Visit the deploys page to approve it
|
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Two active documentation inaccuracies remain: the Vale workflow excludes several Markdown paths, and the Makefile does not enable Corepack before installing dependencies.
2 open issues
What changed in this PR
This PR makes AGENTS.md the central source of repository guidance for coding agents while reducing .github/copilot-instructions.md to Copilot-specific environment and CI information.
Changes:
- Adds verification commands, documentation boundaries, writing rules, lifecycle guidance, and PR conventions to
AGENTS.md. - Removes duplicated repository guidance from the Copilot instructions and links agents to shared documentation.
- Retains Copilot-specific environment setup and pull-request check details.
| File | Description |
|---|---|
| AGENTS.md | Establishes consolidated agent instructions covering verification, documentation structure, authoring rules, boundaries, lifecycle guidance, and pull requests. |
| .github/copilot-instructions.md | Provides concise Copilot-specific environment and CI guidance while delegating general repository rules to AGENTS.md. |
Review effort: Lite
Comment on lines
+20
to
+21
| - Vale lints the prose in changed Markdown and MDX files and posts review comments. | ||
| It doesn't block merge. |
Comment on lines
+10
to
+11
| Run `corepack enable` and `yarn install` once. | ||
| The `make` targets do that for you. |
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.
Agents that work in this repo now get one file, AGENTS.md, with the verify commands, where changes go, boundaries, and PR rules. For writing rules, it links to the style guide and feature status pages instead of repeating them. The Copilot file shrinks to what only Copilot needs.
Jira: https://tigera.atlassian.net/browse/DOCS-3152
None of these files is built into the site, so there is no preview page. Review the files on GitHub.
Checked locally on this branch: yarn test:components, and every link in the changed files resolves.