ct-docs-review

Review Markdown documentation for CLEO style compliance with inline comments.

160|20|Updated Dec 6, 2025
One-click install
npx skills add https://github.com/kryptobaseddev/cleo --skill ct-docs-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ct-docs-review
Source: https://github.com/kryptobaseddev/cleo/tree/main/skills/ct-docs-review
Command: npx skills add https://github.com/kryptobaseddev/cleo --skill ct-docs-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps ensure documentation adheres to the CLEO writing style guide by surfacing readability and formatting issues, reducing back-and-forth edits.

Core Features & Use Cases

  • Inline feedback on markdown documents to highlight style and readability improvements.
  • PR mode support to comment on GitHub pull requests with a cohesive, structured review.
  • Local file review for standalone markdowns, with deterministic issue numbering.
  • Use Case: Review a marketing doc or developer documentation to ensure tone, structure, and consistency.

Quick Start

Run ct-docs-review on a local Markdown file or a GitHub PR to generate inline comments and a summary report.

Frequently Asked Questions about ct-docs-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review markdown documentation for style guide compliance?

To review markdown documentation for style guide compliance, run a review tool that checks files against the CLEO style guide, surfacing readability and formatting issues with deterministic inline comments and a summary report.

Can I add inline comments to a GitHub PR to highlight documentation style issues?

Yes, you can add inline comments to a GitHub PR to highlight documentation style issues. The review process detects PR mode and applies structured, cohesive feedback directly in the pull request context.

What is the CLEO style guide review process for local markdown files?

The CLEO style guide review process for local markdown files analyzes standalone documents and generates a summary report with deterministic issue numbering to ensure consistent guidance and reduce back-and-forth edits.

Do I need any external dependencies to run a CLEO style documentation review?

No external dependencies are required to run a CLEO style documentation review. The process operates independently on local markdown files or GitHub PRs without needing additional modules or components.

What is the best way to ensure consistent tone and structure across developer documentation?

The best way to ensure consistent tone and structure across developer documentation is to enforce a style guide like CLEO, which catches readability issues and reduces back-and-forth edits during the review process.