update-docs-on-code-change
Updates README.md and other documentation when application code changes need documentation updates.
- Kind
- Rules
- Works with
- GitHub Copilot
- Source
- Awesome Copilot @ d85f762d6e52
- Path
- instructions/update-docs-on-code-change.instructions.md
- License
- MIT
- Jobs
- Documentation
InstallCopy it from the source repository, or sign in and let the assistant adapt it for your project.
# Update Documentation on Code Change ## Overview Ensure documentation stays synchronized with code changes by automatically detecting when README.md, API documentation, configuration guides, and other documentation files need updates based on code modifications. ## Instruction Sections and Configuration The following parts of this section, `Instruction Sections and Configurable Instruction Sections` and `Instruction Configuration` are only relevant to THIS instruction file, and are meant to be a method to easily modify how the Copilot instructions are implemented. Essentially the two parts are meant to turn portions or sections of the actual Copilot instructions on or off, and allow for custom cases and conditions for when and how to implement certain sections of this document. ### Instruction Sections and Configurable Instruction Sections There are several instruction sections in this document. The start of an instruction section is indicated by a level two header. Call this an **INSTRUCTION SECTION**. Some instruction sections are configurable. Some are not configurable and will always be used. …