Skip to content

docs: add a docs-review skill - #7153

Draft
Abhishek-Mohan wants to merge 1 commit into
apache:mainfrom
Abhishek-Mohan:docs/4420-docs-review-skill
Draft

Abhishek-Mohan wants to merge 1 commit into
apache:mainfrom
Abhishek-Mohan:docs/4420-docs-review-skill

Conversation

@Abhishek-Mohan

Copy link
Copy Markdown

Note

Draft / placeholder. This branch has only an empty commit for now. The skill will be built on the style guide from the #4419 style guide PR, and will be ready for review after that PR merges.

Which issue does this PR close?

Closes #4420.

Rationale for this change

Comet's docs are growing, and their wording and quality vary. Once the #4419 style guide lands, reviewers need a way to keep new and existing docs consistent with it without checking prose by hand. #4420 proposes a docs-review skill alongside review-comet-pr that gives advisory feedback on documentation.

What changes are included in this PR?

Planned: a new skill at .ai/skills/review-comet-docs/SKILL.md, following the structure of the existing review skills. It will:

  • support two modes: reviewing the docs changes in a PR, and auditing an existing file or directory under docs/source/;
  • check style guide adherence, page structure, completeness, accuracy (config keys, operator names and links exist), tone, ASF license headers, and Comet's docs conventions, as listed in Add a docs-review Claude skill to enforce style guide and documentation quality #4420;
  • return findings grouped as must-fix, should-fix or nit, each with a file and line reference, the rule it breaks, and a suggested rewrite;
  • never edit files, post comments or push branches, the same as review-comet-pr.

How are these changes tested?

I will run the skill against a recent docs PR and an existing docs page, and include sample output in this PR.

AI assistance: OpenCode is being used to help draft this change.

Placeholder commit. Closes apache#4420.

Generated-by: OpenCode
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a docs-review Claude skill to enforce style guide and documentation quality

1 participant