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

docs(bluecraft-agentic-docs): clarify file path reference rules

Browse Source 
Add explicit guidance to use repository-relative paths in
backticks when referencing files from `AGENTS.md` and
`agent-docs/`.

Prevent machine-local absolute paths and Markdown links in
these docs so routing instructions stay portable and
consistent.
This commit is contained in:
Ge Song
2026-03-20 19:02:13 +08:00
parent 8d704cf406
commit 98d5818b32
3 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
skills/bluecraft-agentic-docs/SKILL.md
View File

@@ -30,6 +30,8 @@ Do not use this skill for end-user documentation, product manuals, README conten
- Rules should be actionable, not slogan-like. - Rules should be actionable, not slogan-like.
- Prefer standard Markdown headings and lists over wrapper tags for structure. - Prefer standard Markdown headings and lists over wrapper tags for structure.
- Write for maintainers. State actions, constraints, and decision criteria directly. - Write for maintainers. State actions, constraints, and decision criteria directly.
- When referencing repository files from `AGENTS.md` or `agent-docs/`, prefer plain repository-relative paths in backticks such as `agent-docs/example.md`, not Markdown links.
- Do not embed machine-local absolute filesystem paths such as `/home/...`.
- Do not mix general agentic-documentation rules with project-specific business rules, product instructions, media planning, or end-user documentation guidance in the same general-purpose file. - Do not mix general agentic-documentation rules with project-specific business rules, product instructions, media planning, or end-user documentation guidance in the same general-purpose file.
- Treat the `AGENTS.md` at the root of the current Git working tree as the primary routing entrypoint. - Treat the `AGENTS.md` at the root of the current Git working tree as the primary routing entrypoint.
- Keep common, repository-wide constraints in that root `AGENTS.md`. - Keep common, repository-wide constraints in that root `AGENTS.md`.

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

@@ -26,4 +26,5 @@ Use this structure for the `AGENTS.md` at the root of the current Git working tr
- Keep this file short. - Keep this file short.
- Treat this file as an instruction document, not a passive index. - Treat this file as an instruction document, not a passive index.
- Route to child docs only when they are actually needed. - 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.
- Do not turn the root file into a dump of all topic-specific rules. - Do not turn the root file into a dump of all topic-specific rules.

1
skills/bluecraft-agentic-docs/references/rule-doc-template.md
View File

@@ -31,5 +31,6 @@ Use this structure for Markdown files inside `agent-docs/` when the document's m
- Make the scope explicit. - Make the scope explicit.
- Keep the document responsible for one topic. - Keep the document responsible for one topic.
- Use semantic filenames and headings. - Use semantic filenames and headings.
- If the document references repository files, write repository-relative paths in backticks, not Markdown links or machine-local absolute filesystem paths.
- State the user or maintainer decision directly: what to do, what to avoid, and how to choose. - State the user or maintainer decision directly: what to do, what to avoid, and how to choose.
- Prefer linking to inventories, examples, or narrower child docs instead of embedding long registries inline. - Prefer linking to inventories, examples, or narrower child docs instead of embedding long registries inline.