public/bluecraft
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(bluecraft-agentic-docs): refine documentation structure terminology and patterns

Browse Source 
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
This commit is contained in:
Ge Song
2026-04-20 12:48:31 +08:00
parent 98d5818b32
commit 3bf898afab
5 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
skills/bluecraft-agentic-docs/references/root-agents-template.md
View File

@@ -7,7 +7,7 @@ Use this structure for the `AGENTS.md` at the root of the current Git working tr
```md
# Root Entry
- State that this file is the primary routing entrypoint for the repository's agentic documentation tree.
- State that this file is the root entry for the repository's `agent-docs`.
- Define the default path basis.
# Common Constraints
@@ -15,9 +15,9 @@ Use this structure for the `AGENTS.md` at the root of the current Git working tr
- Keep repository-wide rules here.
- Do not repeat topic-specific rules that belong in child docs.
# Required Instructions Before Editing
# Read Required `agent-docs` Before Editing
- Route to the required child instruction docs.
- List the required `agent-docs` explicitly.
- Use explicit "Read and follow ..." wording.
```
@@ -25,6 +25,6 @@ Use this structure for the `AGENTS.md` at the root of the current Git working tr
- Keep this file short.
- Treat this file as an instruction document, not a passive index.
- Route to child docs only when they are actually needed.
- When routing to child docs, write repository-relative paths in backticks such as `agent-docs/example.md`, not Markdown links or machine-local absolute filesystem paths.
- 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.