AI-Assisted Docs Workflow
sharedHow to keep docs AI-friendly for generation, retrieval, and assistant usage.
Current AI-friendly surfaces
llms.txtandllms-full.txtendpoints in docs app- per-page markdown route under
/llms.mdx/docs/... - structured MDX pages with consistent headings and concise sections
Authoring rules for AI quality
- Prefer explicit section headers and short paragraphs.
- Keep command snippets complete and runnable.
- Use one canonical term for each concept to reduce ambiguity.
- Link related pages so assistants can traverse context quickly.
- Tag pages with
audiencefrontmatter (internal,external-ready,shared).
Recommended internal workflow
- Draft in
/internalfirst for operational accuracy. - Validate with team usage and Q/A.
- Promote to
/docsonce language is external-ready.
Next AI improvements
- add internal-specific LLM exports (
/llms/internal.txt) - add optional frontmatter summary fields for retrieval ranking
- define assistant prompt templates for docs update tasks