Ge Song
98d5818b32
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.
31 lines
956 B
Markdown
31 lines
956 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 primary routing entrypoint for the repository's agentic documentation tree.
|
|
- Define the default path basis.
|
|
|
|
# Common Constraints
|
|
|
|
- Keep repository-wide rules here.
|
|
- Do not repeat topic-specific rules that belong in child docs.
|
|
|
|
# Required Instructions Before Editing
|
|
|
|
- Route to the required child instruction docs.
|
|
- Use explicit "Read and follow ..." wording.
|
|
```
|
|
|
|
## Notes
|
|
|
|
- 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.
|
|
- Do not turn the root file into a dump of all topic-specific rules.
|