Files
bluecraft/skills/bluecraft-agentic-docs/references/root-agents-template.md
Ge Song 3bf898afab docs(bluecraft-agentic-docs): refine documentation structure terminology and patterns
Update skill definition and templates to use "references" instead of "routing"
throughout, clarify the root AGENTS.md as the entry document for agent-docs, and
add explicit linking patterns guidance. Improve template wording to emphasize
directional, explicit references and minimal reference depth.

- Rename and expand linking patterns reference
- Update SKILL.md trigger conditions and core rules
- Refine child doc template compatibility note
- Update refactor checklist to focus on reference depth
- Simplify root AGENTS.md template structure
2026-04-20 12:48:31 +08:00

31 lines
931 B
Markdown

# Root `AGENTS.md` Template
Use this structure for the `AGENTS.md` at the root of the current Git working tree.
## Recommended Shape
```md
# Root Entry
- State that this file is the root entry for the repository's `agent-docs`.
- Define the default path basis.
# Common Constraints
- Keep repository-wide rules here.
- Do not repeat topic-specific rules that belong in child docs.
# Read Required `agent-docs` Before Editing
- List the required `agent-docs` explicitly.
- Use explicit "Read and follow ..." wording.
```
## Notes
- Keep this file short.
- Treat this file as an instruction document, not a passive index.
- Reference child docs only when they are actually needed.
- When referring to child docs, write repository-relative paths in backticks such as `agent-docs/example.md`, not Markdown links or machine-local absolute filesystem paths.
- Do not turn the root file into a dump of all topic-specific rules.