N.B. This README.md is located at docs/README.md and it is displayed in preference to the README.md in the project root. The README preference order is described in the GitHub docs.
This directory contains all project-related documentation, organized into subdirectories based on its purpose.
- Architecture
- ADRs (Architecture Decision Records)
- Design
- Engineering
- PRDs (Product Requirement Documents)
There are four examples of how to influence and use AI to write documentation in this repository:
- Custom agents — Specialized AI behaviors for tasks like development, testing, and code review. As of October 2025, GitHub renamed "Chat Modes" to "Agents".
- Custom chat modes (deprecated) — Preset conversational configurations that shape Copilot's behavior and tone during interactive sessions and document generation.
- Instructions — Repository-specific rules and constraints (coding standards, workflow, style) that the AI must follow when producing content.
- Prompts — Reusable prompt templates for generating consistent artifacts (e.g., ADRs, docs, PRDs). See also write-adr.prompt.md and write-prd.prompt.md.