Skip to content

Commit 7cc772f

Browse files
docs(agent-context): simplify README config section
- 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
1 parent deeb718 commit 7cc772f

2 files changed

Lines changed: 3 additions & 24 deletions

File tree

extensions/agent-context/README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It owns the lifecycle of the managed section delimited by the configurable start
1111
Not every Spec Kit user wants Spec Kit to write into the coding agent's context file. Keeping this behavior in a dedicated, **opt-in** extension lets users:
1212

1313
- **Choose whether to install it at all** - `specify init` does **NOT** install it. Add it explicitly when you want Spec Kit to manage the agent context file; if it is absent or disabled, Spec Kit never creates or modifies that file (the AI context file).
14-
- **Customize the markers** by editing [agent-context-config.yml](./agent-context-config.yml) - the bundled scripts honor the `context_markers` value.
14+
- **Customize the markers** by editing `.specify/extensions/agent-context/agent-context-config.yml` ([agent-context-config.yml](./agent-context-config.yml) in this repo) - the bundled scripts honor the `context_markers` value.
1515
- **Synchronize multiple agent anchors** by setting `context_files` when a project intentionally uses more than one coding agent context file, such as `AGENTS.md` and `CLAUDE.md`.
1616
- **Refresh on demand** by running the `speckit.agent-context.update` command in your agent, or automatically through the hooks declared in [extension.yml](./extension.yml) (`after_specify`, `after_plan`).
1717

@@ -44,28 +44,7 @@ While this extension is disabled (or not installed), nothing in Spec Kit creates
4444
4545
## Configuration
4646

47-
All configuration flows through the extension's own config file at
48-
[agent-context-config.yml](./agent-context-config.yml):
49-
50-
```yaml
51-
# Path to the coding agent context file managed by this extension
52-
context_file: CLAUDE.md
53-
54-
# Optional list of coding agent context files to manage together.
55-
# When non-empty, this takes precedence over context_file.
56-
context_files:
57-
- AGENTS.md
58-
- CLAUDE.md
59-
60-
# Delimiters for the managed Spec Kit section
61-
context_markers:
62-
start: "<!-- SPECKIT START -->"
63-
end: "<!-- SPECKIT END -->"
64-
```
65-
66-
- `context_file` - the project-relative path to the coding agent context file. When empty, the bundled update scripts self-seed it by looking up the active integration's key in this extension's own `agent-context-defaults.json` map. The Specify CLI is never consulted.
67-
- `context_files` - optional project-relative paths to multiple coding agent context files. When non-empty, the list takes precedence over `context_file`. Absolute paths, backslash separators, and `..` path segments are rejected.
68-
- `context_markers.start` / `.end` - the delimiters around the managed section. Edit these to use custom markers.
47+
All configuration flows through the extension's own config file at [agent-context-config.yml](./agent-context-config.yml).
6948

7049
## Requirements
7150

extensions/agent-context/agent-context-config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# EXAMPLE: context_file: CLAUDE.md
66
context_file: ""
77

8-
# WHAT: List of project relative paths to the coding agent context files. If you have both `context_file` and `context_files` filled, then this(`context_files`) takes precedence.
8+
# WHAT: List of project relative paths to the coding agent context files. If you have both `context_file` and `context_files` filled, then this (`context_files`) takes precedence.
99
# REQUIREMENT: OPTIONAL. Use this if your project requires you to keep multiple agent context files in sync.
1010
# EXAMPLE:
1111
# context_files:

0 commit comments

Comments
 (0)