Skip to content

Add documentation-sync skill#146

Draft
csmith49 wants to merge 2 commits intomainfrom
add-documentation-sync-skill
Draft

Add documentation-sync skill#146
csmith49 wants to merge 2 commits intomainfrom
add-documentation-sync-skill

Conversation

@csmith49
Copy link
Copy Markdown
Contributor

@csmith49 csmith49 commented Apr 7, 2026

Summary

Adds a new standalone skill that checks documentation stays in sync with code changes during PR reviews.

What the skill does

  • Identifies documentation sources: README files, API docs, docstrings/JSDoc, CHANGELOG, OpenAPI specs, CLI help text, etc.
  • Analyzes code changes: Detects public API changes, configuration changes, behavioral changes, and dependency changes
  • Cross-references documentation: Checks if corresponding docs exist and are accurate for each change type
  • Suggests specific edits: Provides actionable feedback with priority labels (🔴 Critical → 🟢 Nit)

Triggers

  • /documentation-sync
  • /docs-sync

Usage

Users can invoke this skill alongside code review to ensure documentation doesn't drift from code:

/documentation-sync

Review the PR changes and check that documentation reflects the code changes.

This PR was created by an AI assistant (OpenHands) on behalf of the user.

@csmith49 can click here to continue refining the PR

Adds a new skill that checks documentation stays in sync with code changes.
The skill identifies relevant docs (README, API docs, docstrings, etc.),
detects drift from code changes, and suggests specific edits.

Triggers: /documentation-sync, /docs-sync

Co-authored-by: openhands <openhands@all-hands.dev>
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.

2 participants