Update audit prompts #566
Merged
Update audit prompts #566
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the audit documentation prompt based on external feedback, refining the instructions for documentation generation and maintenance. The changes shift the prompt file extension from .md to .prompt.md and significantly expand the guidance around documentation style, audience, and implementation approach.
Key changes:
- Renamed audit prompt file with
.prompt.mdextension for clarity - Expanded documentation style guide emphasizing description-first approach with source links over inline code
- Added explicit dual-audience requirement (internal maintainers and external developers)
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/prompts/audit-docs.prompt.md |
New prompt file with expanded documentation guidelines and dual-audience focus |
.github/prompts/audit-docs.md |
Removed original prompt file |
.github/copilot-instructions.md |
New AI coding agent instructions documenting architecture, conventions, and workflows |
package.json |
Updated sass dependency from 1.97.1 to 1.97.2 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update
audit-docprompts based on feedback externally received.