Update audit doc overly verbose comments - #606
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The new guidance contains contradictory scope and JSDoc rules, and nested bundled Markdown bypasses the size gate.
Review effort: Balanced
Findings: 9
Open (13)
What changed in this PR
Refines audit skills for tighter scope, shorter comments, and Codex-compatible file sizes while updating package versions.
Changes:
- Extracts large skill sections into bundled references.
- Tightens documentation audit and comment-curation rules.
- Adds a 39 KB skill-file check with tests and updates dependencies.
| File | Description |
|---|---|
package.json |
Updates package patch versions. |
.github/prompts/readme.md |
Clarifies audit scope resolution. |
.github/prompts/audit-docs.prompt.md |
Revises audit-doc rules and scope. |
.github/copilot-instructions.md |
Tightens JSDoc guidance. |
.claude/skills/typescript-code-and-test-standards/SKILL.md |
Condenses standards and extracts references. |
.claude/skills/typescript-code-and-test-standards/references/structure.md |
Adds structural-refactoring guidance. |
.claude/skills/typescript-code-and-test-standards/references/comments-and-jsdoc.md |
Expands concise JSDoc examples. |
.claude/skills/typescript-code-and-test-standards/references/adopting.md |
Extracts adoption instructions. |
.claude/skills/typescript-code-and-test-standards/assets/copilot-instructions.template.md |
Updates reusable JSDoc rules. |
.claude/skills/typescript-code-and-test-standards/agents/test-quality-reviewer.md |
Restricts agent tools and invocation. |
.claude/skills/typescript-code-and-test-standards/agents/comment-and-jsdoc-auditor.md |
Adds verbose-comment checks. |
.claude/skills/check-skills/SKILL.md |
Documents the file-size gate. |
.claude/skills/audit-quality/SKILL.md |
Extracts audit categories. |
.claude/skills/audit-quality/references/audit-categories.md |
Adds detailed quality categories. |
.claude/skills/audit-pr/SKILL.md |
Extracts PR review categories. |
.claude/skills/audit-pr/references/review-categories.md |
Adds detailed PR categories. |
.claude/skills/audit-docs/SKILL.md |
Reorganizes documentation auditing rules. |
.claude/skills/audit-docs/references/writing-guidelines.md |
Extracts writing conventions. |
.claude/skills/audit-docs/references/writing-for-both-readers.md |
Revises document restructuring guidance. |
.claude/skills/audit-docs/references/voice-and-ai-tells.md |
Expands concise-comment examples. |
.claude/skills/audit-docs/references/evidence-and-citation.md |
Clarifies file-level comments. |
.claude/skills/audit-docs/README.md |
Documents revised audit behaviour. |
.claude/skills/audit-docs/assets/audit-report.template.md |
Extends audit reporting fields. |
.claude/skills/audit-docs/agents/surface-auditor.md |
Revises comment-bloat findings. |
.claude/skills/audit-docs/agents/diagram-reviewer.md |
Restricts tools and invocation. |
.claude/skills/audit-docs/agents/curation-reviewer.md |
Revises document-length reporting. |
.claude/skills/audit-docs/agents/coverage-mapper.md |
Clarifies path-bounded coverage. |
.claude/skills/audit-docs/agents/claim-verifier.md |
Restricts tools and invocation. |
.claude/scripts/check-skill-publishability.test.mjs |
Tests the 39 KB budget. |
.claude/scripts/check-skill-publishability.mjs |
Enforces skill Markdown sizes. |
.claude/rules/prompt-skill-sync.md |
Documents synchronized size limits. |
.claude/rules/docs-authoring.md |
Updates comment and restructuring rules. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch was successfully deployed
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.
Did a bunch of optimizations to audit docs including fixing overly verbose comments, inaccurate documentation, and other audit doc issues.
Also, optimized all skills for ChatGPT Codex & updated npm packages.