ensure-docs

Solid

Verify documentation coverage and generate missing docs interactively

AI & Automation 61 stars 8 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 87/100

Stars 20%
60
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Ensure Documentation Coverage Verify documentation coverage across a codebase, report gaps, and generate missing docs with parallel language-specific agents. ## Workflow Complete steps in order. Do not advance until each step’s **Pass** is satisfied. 1. **Language detection** — Follow Phase 1 (language detection) in [`references/workflow.md`](references/workflow.md). - **Pass:** For each language you will verify, you have evidence of at least one matching source file (counts or command output); if none qualify, stop with a short “no applicable languages” message and do not spawn verifiers. 2. **Load standards** — Read the sections for your detected languages (language standards, verifier prompts, consolidation format) in the same reference file. - **Pass:** You can state which standard applies per language (e.g. Google docstrings, JSDoc, GoDoc) before spawning agents. 3. **Parallel verification** — Spawn one verifier per qualifying language using the agent prompts and JSON output shape in the reference (Phase 2). - **Pass:** Each completed agent returns parseable JSON including `language`, `files_scanned`, and `findings` (array, possibly empty). 4. **Consolidated report** — Merge results per Phase 3 (summary table, severity grouping, detailed findings if requested). - **Pass:** The user sees the merged report (inline or written to an agreed path) before you claim the audit is done or propose fixes. 5. **Generation** — Only if `--report-only` is not set: ...

Details

Author
existential-birds
Repository
existential-birds/beagle
Created
5 months ago
Last Updated
today
Language
Shell
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category