From 6f18ff8ff908da7a6934b12bef815f3b99e73757 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Thu, 18 Dec 2025 14:07:05 +1100 Subject: [PATCH] Add copilot reviewer instructions for docs (#26141) --- .github/instructions/docs.en.instructions.md | 31 ++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/instructions/docs.en.instructions.md diff --git a/.github/instructions/docs.en.instructions.md b/.github/instructions/docs.en.instructions.md new file mode 100644 index 0000000000..e4b94bc154 --- /dev/null +++ b/.github/instructions/docs.en.instructions.md @@ -0,0 +1,31 @@ +--- +applyTo: "docs/en/**" +--- + +# Review Guidelines docs/en Tree + +## File System & Structure + +- **Naming:** Use `lowercase_with_underscores` for all filenames. No spaces. +- **Hierarchy:** Markdown files must reside exactly in a first-level category folder. + - Valid: `docs/en/category/file.md` + - Invalid: `docs/en/category/subcategory/file.md` +- **Text Files:** Any `.txt` or `.text` files must start with an underscore (e.g., `_notes.txt`). +- **Assets:** All images/non-docs must be in `/docs/assets/`. Deep nesting is permitted here. +- **Formats:** Prefer **SVG** for diagrams and **PNG** for screenshots. Flag JPG files. + +## Markdown & Style + +- **Headings:** Use Title Case ("First Letter Capitalisation"). + - The Page Title must be the only H1 (`#`). All others must be `##` or lower. + - Do not apply bold or italic styling inside a heading. +- **Formatting:** + - **Bold:** Only for UI elements (buttons, menu items). + - **Italics (Emphasis):** For tool names (e.g., *QGroundControl*). + - **Inline Code:** Use backticks for file paths, parameters, and CLI commands (e.g., `prettier`). +- **Structure:** End every line at the end of a sentence (Semantic Line Breaks). + +## Quality Control + +- **Formatting:** Ensure Prettier rules have been applied. +- **Language:** Enforce **UK English** spelling and grammar.