Skip to content

Validate docs compliance against standard template#55

Open
russellhaering wants to merge 1 commit intomainfrom
review-docs-compliance
Open

Validate docs compliance against standard template#55
russellhaering wants to merge 1 commit intomainfrom
review-docs-compliance

Conversation

@russellhaering
Copy link
Copy Markdown
Contributor

Summary

  • When docs/connector.mdx is in the PR's changed files, the docs-reviewer agent now checks compliance against the standard template from build-connector-docs.md
  • Checks: required structure/section order (T1), frontmatter (T2), capabilities table format (T3), connector actions section (T4), credentials section (T5), cloud/self-hosted tabs (T6), self-hosted YAML patterns (T7), writing standards (T8)
  • When docs are NOT changed, behavior is unchanged — still checks for staleness (D1-D4)

Test plan

  • Open a PR on a connector repo that modifies docs/connector.mdx and verify compliance findings are reported
  • Open a PR on a connector repo that doesn't touch docs and verify staleness checks still work

…e changed

When docs/connector.mdx is in the PR's changed files, the docs-reviewer
agent now checks compliance against the standard template (structure,
frontmatter, capabilities table, tabs, YAML patterns, writing standards).
@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-docs-compliance

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

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