docs(extensions): clarify agent-context README and add config examples#3389
Open
yanukadeneth99 wants to merge 1 commit into
Open
docs(extensions): clarify agent-context README and add config examples#3389yanukadeneth99 wants to merge 1 commit into
yanukadeneth99 wants to merge 1 commit into
Conversation
Rewrite the agent-context extension README to read as plain prose instead of a bullet dump, and add the missing install/disable commands (specify extension add/disable/enable agent-context). Add inline example comments to agent-context-config.yml for context_file/context_files.
mnriem
reviewed
Jul 7, 2026
| # managed by this extension (e.g. CLAUDE.md, AGENTS.md, | ||
| # .github/copilot-instructions.md). Set automatically from the active | ||
| # integration and regenerated during `specify init` or integration switches. | ||
| # EXAMPLE: context_file: CLAUDE.md |
Collaborator
There was a problem hiding this comment.
The # EXAMPLE: context_file: CLAUDE.md here reads as if context_file is something you're expected to fill in. But empty is the intended default — that's what triggers the self-seed from agent-context-defaults.json based on the active integration. If someone copies the example and pins CLAUDE.md, they've overridden the auto-resolution, so switching agents later (e.g. to Copilot) will keep writing the managed block to CLAUDE.md instead of .github/copilot-instructions.md.
Could we reframe it so it's clear this is an override, not a required value? Something like:
# Leave empty to auto-resolve from the active integration (recommended).
# Only set this to override the auto-detected file, e.g.:
# context_file: CLAUDE.md
context_file: ""The context_files example below is fine as-is, since multi-anchor sync genuinely requires the user to list paths explicitly.
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
2 participants
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.
Description
Edited the
agent-contextREADME.mdandagent-context-config.ymlfor clarity. Added the missing install command.Testing
Ran the commands on a project to ensure it's correct. No other testing are required for this.
AI Disclosure
AI was used to check whether there were any active PRs/issues related to this, and then to create a suggested fix for the README. However, I only used that file as a reference and made the changes to the
README.mdmyself.Please do let me know if there are changes/suggestions to be done.