You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add directive that index.md files are auto-generated
AGENTS.md now warns agents not to manually create or edit
ai/**/index.md files since they are generated from frontmatter
and overwritten by the pre-commit hook.
Copy file name to clipboardExpand all lines: lib/agents-md.js
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ const REQUIRED_DIRECTIVES = [
18
18
"root index",// Progressive discovery starting from root
19
19
"vision",// Vision document requirement
20
20
"conflict",// Conflict resolution
21
+
"generated",// Auto-generated files warning
21
22
];
22
23
23
24
// The content for AGENTS.md
@@ -33,6 +34,8 @@ Agents should examine the \`ai/*\` directory listings to understand the availabl
33
34
34
35
Each folder contains an \`index.md\` file that describes the purpose and contents of that folder. Agents can read these index files to learn the function of files in each folder without needing to read every file.
35
36
37
+
**Important:** The \`ai/**/index.md\` files are auto-generated from frontmatter. Do not create or edit these files manually—they will be overwritten by the pre-commit hook.
38
+
36
39
## Progressive Discovery
37
40
38
41
Agents should only consume the root index until they need subfolder contents. For example:
@@ -144,6 +147,8 @@ Agents should examine the \`ai/*\` directory listings to understand the availabl
144
147
145
148
Each folder contains an \`index.md\` file that describes the purpose and contents of that folder. Agents can read these index files to learn the function of files in each folder.
146
149
150
+
**Important:** The \`ai/**/index.md\` files are auto-generated from frontmatter. Do not create or edit these files manually—they will be overwritten by the pre-commit hook.
151
+
147
152
### Progressive Discovery
148
153
149
154
Agents should only consume the root index until they need subfolder contents. For example:
0 commit comments