Docs Review Skill
Use this skill to review documentation changes against Hyperlane docs standards.
When to Use
- •Before committing changes (self-review)
- •When asked to review a PR or diff
- •To check if docs follow project patterns
Instructions
Read and apply the guidelines from .github/prompts/writing-review.md to review the documentation changes.
For PR Reviews
When reviewing a PR, deliver feedback using /inline-pr-comments to post inline comments on specific lines.
Delivery format:
- •Inline comments - For all issues on lines IN the diff
- •Summary body - For:
- •Overall assessment
- •Structure/organization concerns
- •Issues found OUTSIDE the diff (use "## Observations Outside This PR" section)
GitHub API limitation: Can only post inline comments on changed lines. Issues in unchanged code go in the summary body.
For Self-Review
When reviewing your own changes before committing:
- •Run
git diffto see changes - •Apply the review guidelines
- •Fix issues directly rather than commenting