Add pattern consistency and admonition weight checks to docs-review skill#690
Merged
Add pattern consistency and admonition weight checks to docs-review skill#690
Conversation
…kill Two structural issues in PR #685 were missed by the docs-review skill because it lacked checks for peer-concept documentation patterns and admonition-level proportionality. Adds both. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the docs-review skill checklist to cover two editorial gaps identified during review of prior documentation changes, strengthening structural and navigational review criteria across the ToolHive docs set.
Changes:
- Add an Admonition weight check to flag when key feature documentation is incorrectly buried inside tips/notes/warnings.
- Add a Pattern consistency for peer concepts check to ensure new resources/features follow established doc patterns used by comparable “peer” concepts (e.g., dedicated pages and parallel placement).
rdimitrov
approved these changes
Apr 10, 2026
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.
Description
Adds two new review checks to the docs-review skill that were identified as gaps during the editorial review of #685:
Type of change
Related issues/PRs
Submitter checklist
Content and formatting
🤖 Generated with Claude Code