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
Copy file name to clipboardExpand all lines: AGENTS.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,12 @@ Current repository layout:
20
20
doc.md # module routing and load conditions
21
21
awesome/ # enforced utility/library registry by stack or capability
22
22
index.md
23
-
<stack>.md
23
+
<name>.md
24
24
shared/ # reusable cross-stack rulesets
25
25
<rule-name>.md
26
26
skills/ # skills used to integrate with these policies
27
-
<skill-name>.md
27
+
<skill-name>/
28
+
SKILL.md
28
29
modules/ # stack-specific guidance
29
30
<module-name>/doc.md
30
31
```
@@ -41,7 +42,7 @@ Current repository layout:
41
42
-`doc.md` must provide a canonical table with short stack key, full stack name, module path, and `load_when`.
42
43
-`doc.md` must instruct agents to always load baseline modules and load project-specific stacks by `load_when` signals.
43
44
-`doc.md` must define section semantics: `Strict rules` for technical constraints, and `Working Agreements` for user-agent interaction protocol.
44
-
-`doc.md` must define how to load and enforce `awesome/index.md` and stack-specific awesome files.
45
+
-`doc.md` must define how to load and enforce `awesome/index.md` and matching awesome files.
45
46
- Changes to module paths or routing signals must update `doc.md` in the same change.
46
47
- When adding a new stack, update `doc.md` with both the short stack key and full stack name.
47
48
- Root `doc.md` should contain only routing/composition logic and helpers to assemble target `AGENTS.md`.
@@ -53,6 +54,13 @@ Current repository layout:
53
54
- Stack modules must link extracted shared rules by relative path (for module files: `[shared/<rule-name>.md](../../shared/<rule-name>.md)`).
54
55
- Keep shared files concrete and tool-focused; stack modules should keep only stack-specific additions.
55
56
57
+
## Skills
58
+
- Skills are maintained in `skills/<skill-name>/SKILL.md`.
59
+
- Skills must treat `doc.md` and `awesome/index.md` as the source of truth and must not introduce alternate router filenames.
60
+
- Skills that initialize from scratch or refactor existing repositories must run an architecture interview before selecting modules or refactoring code.
61
+
- Skills must wait for explicit `Accept` before writing `AGENTS.md` or performing architecture-driven refactors.
62
+
- Skills that mutate an existing codebase must propose a phased plan before editing files.
63
+
56
64
## Rules combination
57
65
Rules in this project must be combined so a target agent can merge them into a single `AGENTS.md` using the contract defined in `doc.md`.
`Use https://github.com/RevoTale/agent-docs/skills/refactor-project-to-agent-docs skill to align this repository with the recommended stack after an architecture interview.`
46
+
47
+
## Update Manually
48
+
49
+
You can still update `AGENTS.md` manually when automation is not desired.
33
50
34
51
1. Create a root `AGENTS.md` if missing.
35
52
2. Add `https://github.com/RevoTale/agent-docs/blob/main/doc.md` under `Base Policy Links (Load First)`.
0 commit comments