Update the /audit-docs for shorter passages - #600
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The docs guidance updates introduce wording/instruction inconsistencies that should be reconciled, and the unrelated dependency upgrades broaden the PR scope beyond what the title/description claims.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the /audit-docs prompt/skill guidance to more strongly prefer concise documentation and to add an explicit “split overview vs depth” and “complement long prose with diagrams/tables/snippets” workflow, while also bumping several runtime/dev dependencies.
Changes:
- Added a new “Rule 6: Brevity and document scope” to
/audit-docs(prompt + skill), plus supporting updates to templates and helper agents. - Extended the
surface-auditorandcuration-revieweragents to detect/report excessive length (comments and documents). - Upgraded dependencies including
firebase,next,eslint, andsass(with lockfile updates).
File summaries
| File | Description |
|---|---|
package.json |
Bumps runtime/dev dependency versions (unrelated to /audit-docs guidance changes). |
package-lock.json |
Lockfile refresh corresponding to the dependency upgrades. |
.github/prompts/audit-docs.prompt.md |
Adds brevity/splitting/complementing guidance and refines wording in the prompt version of /audit-docs. |
.claude/skills/audit-docs/SKILL.md |
Mirrors the new brevity/splitting/complementing guidance in the skill version of /audit-docs. |
.claude/skills/audit-docs/references/writing-for-both-readers.md |
Adds “document length as a whole” guidance and examples intended to support Rule 6. |
.claude/skills/audit-docs/assets/audit-report.template.md |
Extends the audit report template to capture “split” and “length” outcomes. |
.claude/skills/audit-docs/agents/surface-auditor.md |
Extends the discovery agent to report overly verbose comments for compression. |
.claude/skills/audit-docs/agents/curation-reviewer.md |
Adds an explicit “length as a whole” verdict for document review. |
.claude/rules/docs-authoring.md |
Updates repo-wide markdown authoring rules to include brevity/splitting/complementing guidance. |
Review details
- Files reviewed: 8/9 changed files
- Comments generated: 6
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
AlexJSully
deleted the
alexjsully-260904-update-docs-shorter-passages
branch
September 4, 2026 18:33
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.
Update the
/audit-docsto prefer shorter passages and when long passages are present, compliant it with some diagrams or tables or something more easily consumable.