Repository navigation
docs: add a docs-review skill - #7153
Draft
Abhishek-Mohan wants to merge 1 commit into
Draft
Abhishek-Mohan wants to merge 1 commit into
Abhishek-Mohan wants to merge 1 commit into
Conversation
Placeholder commit. Closes apache#4420. Generated-by: OpenCode
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-prthat 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:docs/source/;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.