Improve doc audit AI prompt #558
Merged
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 documentation audit AI prompt to enforce stricter rules and improve clarity. The changes enhance guidelines for documentation accuracy, require verification of code references, and mandate the use of visual diagrams and file links.
Key changes:
- Restructured prompt with explicit "HARD RULES" section to prevent speculative or invented content
- Added detailed requirements for Mermaid diagrams and markdown file links
- Updated dependency versions (@sentry packages)
- Fixed documentation link paths across multiple files
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Updated @sentry packages from 10.28.0 to 10.29.0 |
| docs/usage/index.md | Corrected component documentation paths and removed list formatting |
| docs/architecture/layouts.md | Fixed component architecture link path |
| docs/architecture/index.md | Corrected component documentation paths |
| docs/architecture/images.md | Fixed component documentation link path |
| docs/architecture/helpers.md | Updated code examples to reflect actual helper function names and usage |
| docs/architecture/data.md | Corrected component documentation link path |
| docs/architecture/components/projects.md | Expanded project object example with complete field structure |
| .github/prompts/audit-docs.md | Major restructuring with stricter rules, enhanced guidelines, and clearer instructions |
💡 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.
No description provided.