This directory stores authoring guidance, templates, and review prompts used to maintain the documentation repository. Nothing here is published on the website.
| Folder | Purpose | Entry point |
|---|---|---|
authoring/ |
Area‑specific writing rules: expected sections, components, frontmatter, and conventions per doc type | /agents/authoring/README.md |
templates/ |
Copy‑paste skeletons for new pages, with correct structure and placeholders | /agents/templates/README.md |
prompts/ |
Specialized prompts for reviewing and creating documentation (style, structure, UX) | /agents/prompts/README.md |
How these pieces connect: authoring guides define the rules, templates encode them as ready‑to‑use skeletons, and prompts automate checking against them.
- Human authors and reviewers who want consistent page structure and conventions.
- Automation and AI tools that scaffold or validate docs without touching published content.
- Find the right template in
agents/templates/README.md. - Copy it into
docusaurus/docs/..., fill in placeholders, and read the corresponding authoring guide for area‑specific conventions. - Open a PR following the commit and branch rules in
AGENTS.md.
For the full step‑by‑step, see agents/templates/README.md.
- Read area guides (
agents/authoring/AGENTS.*.md) for expected structure. - Use templates (
agents/templates/*.md) when scaffolding new pages. - Use prompts (
agents/prompts/*.md) to decide where and what to write, then run style, structure, and UX checks. - Never write to
agents/**when publishing docs; always targetdocusaurus/docs/**.
- Excluded from build:
docusaurus/docusaurus.config.jsexcludesAGENTS.*,templates/**, and../agents/**patterns. - Not in sidebars: no agent files are referenced in
docusaurus/sidebars.js. - Excluded from LLMs: generators ignore
AGENTSandtemplates(and anyagents/**) paths.
- Do keep repo‑relative, clickable paths when linking files.
- Do keep templates minimal, with clear placeholders and path hints in code fences (e.g.,
title="/config/<area>.js"). - Don't place agent files back under
docusaurus/docs/**. - Don't include agents/templates in search configs or LLM datasets.
- Root agent guide:
AGENTS.md - Authoring area guides:
/agents/authoring/AGENTS.*.md