Update copilot-instructions.md (#48004)

adegeo · web-flow · commit fffd985cd794 · 2025-08-19T09:43:00.000-07:00
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -1,12 +1,23 @@
 # .NET Documentation Guidelines
 
+## Disclosure
+
+For any Markdown files generated by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair:
+
+```markdown
+ai-usage: ai-generated
+```
+
 ## Terminology
+
 - Unless otherwise specified, all .NET content refers to modern .NET (not .NET Framework).
 
 ## Writing Style
+
 Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics:
 
 ### Voice and Tone
+
 - Active voice, second person addressing reader directly.
 - Conversational tone with contractions.
 - Present tense for instructions/descriptions.
@@ -16,6 +27,7 @@ Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-g
 - Avoid "we"/"our" referring to documentation authors or product teams.
 
 ### Structure and Format
+
 - Sentence case headings (no gerunds in titles).
 - Be concise, break up long sentences.
 - Oxford comma in lists.
@@ -26,13 +38,15 @@ Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-g
 - No consecutive headings without content between them.
 
 ### Formatting Conventions
+
 - **Bold** for UI elements.
 - `Code style` for file names, folders, custom types, non-localizable text.
 - Raw URLs in angle brackets.
 - Use relative links for files in this repo.
 - Remove `https://learn.microsoft.com/en-us` from learn.microsoft.com links.
 
 ## API References
+
 Use cross-references: `<xref:api-doc-ID>`.
 
 To find API doc IDs:
@@ -43,6 +57,7 @@ To find API doc IDs:
 If unsure, use API browser: `https://learn.microsoft.com/api/apibrowser/dotnet/search?api-version=0.2&locale=en-us&search={API_NAME}&$skip=0&$top=5` and then use the `url` value from the results as a manual link.
 
 ## Code Snippets
+
 For snippets >6 lines:
 1. Create `./snippets/my-doc/language` folder in same directory as document (for a document named `my-doc.md`) where language is either vb (for visual basic) or csharp (for c#). Omit the `language` component when the document is in the `docs/visual-basic`, `docs/csharp`, or `docs/fsharp` folders.
 1. Add snippet as separate code file.
@@ -52,8 +67,10 @@ For snippets >6 lines:
 1. When you add code, use code comments sparingly because they don't get localized. You can use them to briefly clarify code-specific details (such as logic, parameters, or edge cases). Put any critical information and context in the markdown text of the referencing article.
 
 ## File Naming
+
 New Markdown files: lowercase with hyphens, omit filler words (the, a, etc.).
 
 ## Special Cases
+
 - Breaking changes: Include directions from `.github/prompts/breaking-change.md`.
 - When you (Copilot) are assigned an issue in GitHub, after you've completed your work and the workflows (status checks) have run, check to make sure there are no build warnings under the OpenPublishing.Build status check. If there are, open the build report (under View Details) and resolve any build warnings you introduced.
