Skip to content

Conversation

@jhauga
Copy link
Contributor

@jhauga jhauga commented Dec 12, 2025

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.

Description

Overview

Instructions that will update documentation based on code changes. Essentially - if the code changes merit an update to the documentation of a repository or project, then these instructions will apply documentation changes automatically.

Testing

Ran on a new repo. It updated the docs after prompting Copilot for new options, and changes to how existing features work. Had to debug elements that would not need documenting, and seemed to not update when it was not supposed to update. The main documentation updates it applied were in regards to two new command options quiz-agent and delete.

Prior to testing, those two commands were not part of the tool. All documentation regarding them was from testing this PR. And most of the documentation regarding the repo prompt-quiz-cmd being a command line tool and not a VS Code extension.

So essentially I copied and pasted prompt-quiz (VS Code ext.) to prompt-quiz-cmd, added the instruction file, and converted it into a command line tool. That's right! So all documentation about it being a command line tool was updated from these instructions as well. Half of the edits before git init, and the other half after git init - so works well when not a git repo.

One drawback (I guess) is that when prompted to add a new feature, or rework an existing feature; the prompt seems to take longer. But one way of looking at that is - means the instructions were being processed. When prompting Copilot to make minor changes, the time to completion seemed normal. When prompting Copilot to specifically make a change to the documentation, then Copilot did take longer. Curious to why that was the case, but it didn't have any timeouts or anything. And sometimes Copilot is just slow.

Side Note

I got the idea from a twit.tv episode. Forgot which one, but thought I'd give them credit for it.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • New collection file.
  • Update to existing instruction, prompt, chat mode, or collection.
  • Other (please specify):

By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Copilot AI review requested due to automatic review settings December 12, 2025 02:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new instruction file that automatically updates documentation when code changes are made. The instruction provides comprehensive guidance for keeping README.md, API documentation, and other docs synchronized with code modifications.

Key Changes

  • Introduces a configurable instruction framework with boolean flags to control which documentation update rules apply
  • Provides extensive documentation update rules covering README updates, API documentation, code examples, configuration docs, and migration guides
  • Includes quality standards, validation commands, and best practices for documentation maintenance

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
instructions/update-docs-on-code-change.instructions.md New instruction file with comprehensive documentation update rules and a custom configurable instruction framework
docs/README.instructions.md Added entry for the new instruction file with install badges and description

Modified one of the suggestions, clarifying the terms and instruction file configuration. If possible look over and see if another edit is needed.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant