Update audit prompt to include audit codebase when docs is up to date #562
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 prompt to ensure documentation is reviewed before auditing the codebase, and updates Node package dependencies to their latest versions.
- Modified the audit prompt to review
docs/directory first, then audit markdown and code documentation only ifdocs/is already accurate - Updated 14 npm package versions to their latest releases
- Enhanced testing documentation with improved flowcharts, command examples, and validation workflow details
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Updated 14 dependency versions including Next.js, Firebase, Sentry, and testing libraries |
| docs/usage/testing.md | Enhanced testing documentation with improved flowchart, added Jest commands, and detailed validation workflow |
| docs/index.md | Removed emoji decorators and simplified formatting |
| docs/architecture/index.md | Expanded architecture documentation with detailed directory structure and system flow |
| docs/architecture/components/stars.md | Added comprehensive documentation for StarsBackground component |
| docs/architecture/components/navbar.md | Added detailed documentation for Navbar component with interaction flows |
| docs/architecture/components/index.md | Significantly expanded component documentation with hierarchy, relationships, and data flow |
| docs/architecture/components/avatar.md | Added complete documentation for Banner and Avatar components including Easter egg details |
| .github/prompts/audit-docs.md | Updated audit prompt to enforce execution order: docs first, then codebase |
💡 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 prompt to include audit codebase when docs is up to date. This includes running that audit prompt.
Also update node package versions.