Skip to content

feat: add documentation staleness checks to PR review skill#52

Merged
russellhaering merged 1 commit intomainfrom
review-skill-docs-staleness
Feb 26, 2026
Merged

feat: add documentation staleness checks to PR review skill#52
russellhaering merged 1 commit intomainfrom
review-skill-docs-staleness

Conversation

@russellhaering
Copy link
Copy Markdown
Contributor

Summary

  • Adds D1-D4 documentation staleness checks to the PR review skill
  • Flags PRs that change documented connector functionality without updating docs/connector.mdx

What it checks

Code Trigger Docs section affected
D1 Resource types added/removed, sync/provision support changed Capabilities table
D2 Action schemas added/removed/modified in *_actions.go Connector actions table
D3 Required API scopes or permissions changed Credential gathering
D4 Config fields added/removed/renamed Configuration instructions

Only warns if docs/connector.mdx exists but isn't already in the PR's changed files. Reads the actual docs to confirm staleness rather than guessing.

Flag PRs that change documented functionality (capabilities, actions,
credentials, config) without updating docs/connector.mdx.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 26, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • skills/pr-review.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch review-skill-docs-staleness

Comment @coderabbitai help to get the list of available commands and usage tips.

@russellhaering russellhaering merged commit 3e4b018 into main Feb 26, 2026
2 checks passed
@russellhaering russellhaering deleted the review-skill-docs-staleness branch February 26, 2026 16:40
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.

1 participant