Instruction file imported from microsoft/learn-ai-native-dev (
.github/instructions/docs.instructions.md). Copyright stays with the author.
Editing docs/
docs/ is the design specification for the website-as-product. It is
not the contributor harness — that lives in .github/.
Rules
- Reflect, don't invent. Every claim in
docs/must be backed by code insrc/or by an existing.github/policy file. Aspirations belong in issues, not in design docs. - One topic per file. Link, don't duplicate. If two docs need the same passage, factor it into a third doc and link from both.
- Use relative links to other workspace files (no absolute URLs to the
repo, no
vscode://schemes). Keep links inline; do not wrap file paths in backticks. - Tables for inventories. When listing modules, components, instructions,
prompts, skills, agents, or hooks, prefer a table with a
Sourcecolumn that links to the file. - Keep
docs/lifecycle.mda thin summary. The authoritative lifecycle policy is.github/CONTENT_LIFECYCLE.md. When they conflict, the.githubfile wins. - Never put generated content here. Anything a tool writes belongs under
the harness or the build output, not under
docs/. - Use plain language. No jargon without a one-line definition. Match
the voice rules in
docs/design-principles.md. @docs-auditoris the maintainer. When you changesrc/,paths.ts, a markdown module, a diagram, a custom syntax handler, or any.github/{instructions,prompts,skills,agents,hooks}/*file, run@docs-auditorbefore merging.
Forbidden
- Adding new design principles without sign-off in an issue.
- Embedding code snippets longer than ~15 lines (link to the source instead).
- Restating tutorial content (this is a design spec, not a tutorial).
- Changing the website's voice or visual rules in
docs/without a corresponding change in code or inreact-components.instructions.md.
Building / verifying
docs/ is markdown only — no build step. Verify a change by:
- Reading the file in VS Code's preview.
- Running
@docs-auditorto confirm no drift was introduced.