add update-docs-on-code-change instructions#487
+550 −0
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis 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-agentanddelete.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-cmdbeing 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 aftergit init- so works well when not agitrepo.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
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.