docs(extensions): clarify agent-context README and add config examples#3389
Merged
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
- Reformat comments to flow as single-line paragraphs instead of multi-line breaks - Add "WHAT" sections describing each configuration option's purpose - Add "REQUIREMENT" sections specifying if options are optional or required - Add explicit EXAMPLE sections for context_markers configuration - Improve clarity of context_file and context_files option descriptions
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the bundled agent-context extension documentation to better explain its opt-in behavior and configuration, and adds an explicit install command to the README.
Changes:
- Expanded
extensions/agent-context/README.mdwith installation/disabling instructions and clearer “opt-in” explanation. - Added more descriptive inline documentation and examples to
extensions/agent-context/agent-context-config.yml.
Show a summary per file
| File | Description |
|---|---|
| extensions/agent-context/README.md | Clarifies extension behavior and adds install/disable instructions; includes an Issues section link. |
| extensions/agent-context/agent-context-config.yml | Adds more explicit WHAT/REQUIREMENT/EXAMPLE guidance for config fields. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Low
mnriem
requested changes
Jul 8, 2026
- Fix "Github" -> "GitHub" casing in README issues link - Clarify agent-context-config.yml comments on context_file/context_files behavior and precedence
Collaborator
|
Please address Copilot feedback |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
- Clarify config file path reference (.specify/extensions path vs repo path) - Remove duplicated YAML example/field docs from README, point to config file directly - Minor spacing fix in agent-context-config.yml comment
Contributor
Author
|
Apologies for the delay! Should be all good now |
- Reference the installed .specify config path alongside the repo-relative link
mnriem
requested changes
Jul 16, 2026
mnriem
left a comment
mnriem
left a comment
Collaborator
There was a problem hiding this comment.
Please address Copilot feedback
- README: clarify install command must be run from an initialized Spec Kit project root - config: correct context_markers requirement from REQUIRED to OPTIONAL
Contributor
Author
|
Done |
mnriem
requested changes
Jul 16, 2026
mnriem
left a comment
mnriem
left a comment
Collaborator
There was a problem hiding this comment.
Please address Copilot feedback
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
- Document that context_file/context_files are relative to the project root (directory containing .specify/) - State the rejected path forms (absolute paths, backslash separators, .. segments) directly in each field's WHAT comment
Contributor
Author
|
Done ser. Updated. |
Collaborator
|
Please address Copilot feedback |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
@mnriem done ser |
Contributor
There was a problem hiding this comment.
Review details
Comments suppressed due to low confidence (1)
extensions/agent-context/README.md:35
- The config can still be read and the block updated after disabling if the user manually invokes the generated command, because disabling leaves that command file installed. This paragraph should describe the automatic-hook behavior rather than promise that nothing can read or modify the file.
While this extension is disabled (or not installed), nothing in Spec Kit creates, updates, or removes the managed block - the `__CONTEXT_FILE__` placeholder in any template is left as-is, and the extension's own config is never read.
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Medium
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Review details
Comments suppressed due to low confidence (1)
extensions/agent-context/README.md:5
- “Everything else is untouched” is not true for all supported context files. The update scripts normalize line endings across the file, and for
.mdctargets they can add or repairalwaysApply: truefrontmatter outside the managed markers (scripts/bash/update-agent-context.sh:357-430, with equivalent PowerShell behavior). Please qualify this guarantee so users know the extension may modify content outside the block.
It owns the lifecycle of the managed section delimited by the configurable start/end markers (defaults: `<!-- SPECKIT START -->` / `<!-- SPECKIT END -->`). Everything else is untouched.
- Files reviewed: 2/2 changed files
- Comments generated: 0 new
- Review effort level: Medium
- Clarify that .mdc files get alwaysApply: true set in frontmatter, outside the managed marker block - Fix "Everything else is untouched" wording so it doesn't contradict the exception right above it
Contributor
Author
|
Fixed the copilot feedback |
mnriem
approved these changes
Jul 23, 2026
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.
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.