From 9ad33bc9a0c0014b6796a5565a8403b559e23372 Mon Sep 17 00:00:00 2001 From: Ashley Childress <6563688+anchildress1@users.noreply.github.com> Date: Wed, 10 Dec 2025 22:34:28 -0500 Subject: [PATCH] chore: add Copilot review instructions and docs AGENTS.md - Add AGENTS.md with guidelines for consistent user documentation - Add copilot-instructions.md for automated code review standards - Include DocFX requirements and deployment constraints Commimt-generated-by: GitHub Copilot Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com> --- .github/copilot-instructions.md | 4 ++++ docs/AGENTS.md | 16 ++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .github/copilot-instructions.md create mode 100644 docs/AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000000..ba17eefb62 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,4 @@ +# Copilot instructions for automated code reviews 🌱 + +- Reference [AGENTS.md](../AGENTS.md) as the authoritative source for project conventions when reviewing any files changed in this repo. +- For files in `docs/`, additionally consult the [./docs AGENTS.md](../docs/AGENTS.md) for additional requirements designed to promote consistency in independent documentation contributions. diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 0000000000..42db9d904b --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,16 @@ +# AGENTS.md for Spec Kit documentation + +## Guidelines for consistent user documentation + +- The correct syntax for this project is "Spec Kit" (two words, capital S and K). Never use any other variation outside of code snippets. +- Use active voice and present tense where possible. +- Write for an audience familiar with AI and programming concepts, but new to Spec Kit. +- Ensure an informal narrative, teaching voice: give a one-line "why" plus a one-line "how" and a minimal, copy‑pastable example/command when helpful. +- User documentation files are expected to use kebab-case for the `.md` extension, except for special files like `README.md`. +- Examples should be copy-pastable in fenced code blocks and accurate; if unsure, prefer not to change examples. + +## GitHub Pages Deployment Constraints + +- Documentation is hosted at `https://github.github.io/spec-kit/` via GitHub Pages deployment defined by `.github/docs.yml`. +- The static site is generated with DocFX. Use library ID `/dotnet/docfx` if referencing `context7` MCP. +- All documentation changes must be aligned with these standard flows, else deployments will fail.