diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 7c3fa1b632662..4f6ad99f24ff1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -58,6 +58,30 @@ Examples: - ❌ Bad: `configure_logging.md` - ❌ Bad: `DependencyInjectionGuidelines.md` +## Documentation from External Sources (Blog Posts, Announcements) + +When adapting content from external sources like blog posts into documentation: + +**DO:** +- Work on one version, or topic at a time - never combine multiple versions in a single PR. Some blog posts or source material may include many versions or preview builds. The issue or task should specify which one to focus on. +- Copy working code samples directly from source when available. Follow the rules under ["Code Snippets"](#code-snippets) above. +- Create a checklist TODO for each section of the source document before writing. +- Map each documentation section 1:1 to source content. +- Explicitly state what is copied vs. generated in PR description. +- Add disclaimers about AI usage when applicable. + +**DON'T:** +- Invent or elaborate on features not explicitly mentioned in source. +- Create placeholder sections without content. +- Assume feature details or characteristics. +- Combine information from multiple versions/sources. +- Add examples without verifying they demonstrate the stated feature. + +**PR Description Must Include:** +- Content source breakdown. In the description, list each section of the source document and indicate whether it was copied verbatim, adapted, or newly generated. +- Note all generated sections requiring expert review. +- Clear warnings about any uncertainties. + ## Special Cases ### Breaking Changes