Improve the audit-docs prompt#585
Merged
Merged
Conversation
|
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-docs documentation-auditing prompt and related Claude “audit-docs” skill/rules to produce more natural, human technical-writing tone while staying strictly factual. It also includes dependency updates plus a few documentation edits that appear to be the result of running the prompt.
Changes:
- Expanded
audit-docsprompt guidance with a dedicated Voice section to reduce “robotic” prose while keeping strict factual/citation rules. - Updated Claude skill/rules/hooks to align with the canonical prompt’s tone guidance.
- Updated a handful of docs (Mermaid diagram syntax, component descriptions) and bumped multiple dependencies/lockfile.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Bumps Next/React/types/concurrently/prettier versions. |
| package-lock.json | Regenerates lockfile to reflect dependency upgrades/resolutions. |
| docs/usage/testing.md | Tweaks Cypress example comment wording. |
| docs/architecture/data.md | Updates Mermaid sequence diagram participant declarations. |
| docs/architecture/components/index.md | Refines component descriptions (Footer/Publications) and formatting. |
| docs/architecture/components/avatar.md | Aligns AAAAHHHH description with current Avatar behaviour/logging. |
| .github/prompts/audit-docs.prompt.md | Adds/clarifies tone (“Voice”) guidance while preserving strict factual rules. |
| .claude/skills/audit-docs/SKILL.md | Aligns skill summary with updated canonical prompt voice guidance. |
| .claude/rules/docs-authoring.md | Adds voice guidance and clarifies prose vs list usage conventions. |
| .claude/hooks/markdown-audit-reminder.mts | Updates reminder text to reference “not robotic” prose guidance. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
Got feedback that the
audit-docsprompt returns too robotic sounding documentation. Updated and added tonal information in theaudit-docsand also ran it here as a test.