Skip to content

Commit 6b4ba02

Browse files
docs(agent-context): clarify context_file path rules
- 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
1 parent fac9534 commit 6b4ba02

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Coding Agent Context Extension Configuration
22

3-
# WHAT: Single project relative path to the main coding agent context file.
3+
# WHAT: The single agent context file relative to the project root (the directory containing .specify/). Absolute paths, backslash separators, and `..` path segments are rejected.
44
# REQUIREMENT: OPTIONAL. Use this if you want to manually specify a single context file. If you leave this entry blank, it will use the default context file for the coding agent you picked when you set up Spec Kit. See `agent-context-defaults.json` for the defaults.
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 agent context files relative to the project root (the directory containing .specify/). If you have both `context_file` and `context_files` filled, then this (`context_files`) takes precedence. Absolute paths, backslash separators, and `..` path segments are rejected.
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)