docs-check

Name: docs-check
Availability: InStock
Author: mikecubed

Detect missing JSDoc, docstrings, and READMEs across five languages.

Updated Mar 18, 2026

Search Tags:#documentation #readability #code-quality #static-analysis #docstring #lint

Ready to run

npx skills add https://github.com/mikecubed/agent-orchestration --skill docs-check-mikecubed

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/mikecubed/agent-orchestration/tree/main/plugins/ccc/skills/docs-check
Command: npx skills add https://github.com/mikecubed/agent-orchestration --skill docs-check-mikecubed

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation coverage enforcement for TypeScript, JavaScript, Python, Go, and Rust. Detects missing JSDoc/docstrings on exported symbols, misleading or stale inline comments, and absent README files in new packages. Wired into the conductor's review operation.

Core Features & Use Cases

Enforces presence of documentation comments on exported/API symbols (JSDoc/docstrings) across supported languages
Detects misleading or stale inline comments and flags potential discrepancies
Checks for missing READMEs in newly created packages or modules
Guides maintainers to keep code documentation aligned with implementation

Quick Start

Run the docs-check workflow during pull requests to flag missing docs, stale comments, and absent READMEs.

Frequently Asked Questions about docs-check

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

FAQPage Schema

How do I enforce JSDoc and docstring coverage on exported symbols?▼

You can enforce documentation coverage by running a static analysis check on exported API surfaces to detect missing JSDoc or docstrings and flag them with clear remediation steps.

How do I detect misleading or stale inline comments in my codebase?▼

Detecting misleading inline comments is handled by static analysis rules that compare comments against code implementation, flagging potential discrepancies to help maintainers keep documentation aligned.

How do I check for missing READMEs in newly created packages?▼

Checking for missing READMEs involves scanning newly created packages or modules during pull requests to verify README presence, warning you when required documentation files are absent.

Does documentation coverage enforcement work with Python, Go, and Rust?▼

Documentation coverage enforcement supports TypeScript, JavaScript, Python, Go, and Rust by detecting missing docstrings and README files across these languages with warning-level priority.

What is the best way to automate documentation checks during pull requests?▼

Automating documentation checks during pull requests is achieved by wiring static analysis detection rules into the review operation to flag missing docs, stale comments, and absent READMEs.

Why does static documentation linting flag my exported symbols for missing docs?▼

Static documentation linting flags exported symbols because they represent your public API surface, requiring accurate and up-to-date docstrings or JSDoc to ensure codebase documentation integrity.