Skip to content

Add pattern consistency and admonition weight checks to docs-review skill#690

Merged
rdimitrov merged 1 commit intomainfrom
update-docs-review-skill
Apr 10, 2026
Merged

Add pattern consistency and admonition weight checks to docs-review skill#690
rdimitrov merged 1 commit intomainfrom
update-docs-review-skill

Conversation

@danbarr
Copy link
Copy Markdown
Collaborator

@danbarr danbarr commented Apr 10, 2026

Description

Adds two new review checks to the docs-review skill that were identified as gaps during the editorial review of #685:

  • Pattern consistency for peer concepts (Section Structure and Navigation): When a PR introduces a new resource type or component that has established peers, check whether it follows the same documentation pattern. Catches cases like a new CRD being documented only as a subsection when its peers each have dedicated pages.
  • Admonition weight (Structure and Length): Tips, notes, and warnings should be supplementary. If an admonition is the only place a feature is documented, it should be promoted to a proper section with ToC visibility.

Type of change

  • Documentation update

Related issues/PRs

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

🤖 Generated with Claude Code

…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>
Copilot AI review requested due to automatic review settings April 10, 2026 01:12
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 10, 2026 1:14am

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 rdimitrov merged commit 5eb5d05 into main Apr 10, 2026
8 checks passed
@rdimitrov rdimitrov deleted the update-docs-review-skill branch April 10, 2026 05:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants