draft-docs

Solid

Generate first-draft technical documentation from code analysis

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

# Draft Docs Generate Reference or How-To documentation drafts to `docs/drafts/` for review before publishing. ## Arguments - **Topic prompt:** Description of what to document (e.g., "Document the WebSocket API") - **--publish [file]:** Move reviewed draft to final location and update navigation ## Mode 1: Generate Draft ``` /beagle-docs:draft-docs "Document the authentication middleware" ``` ### Step 0: Gather Context Before parsing input, gather project context: ```bash # Check for existing docs structure ls -la docs/ 2>/dev/null || echo "No docs/ directory found" # Identify documentation framework ls docs/navigation.json docs/mint.json docs/docusaurus.config.js docs/mkdocs.yml 2>/dev/null | head -1 # Check for existing drafts ls docs/drafts/*.md 2>/dev/null || echo "No existing drafts" # Get recent code changes for context git diff --name-only $(git merge-base HEAD main)..HEAD 2>/dev/null | head -20 ``` **Capture:** - Docs structure: `docs/` subdirectories present - Navigation system: `navigation.json`, `mint.json`, or other config - Tech stack hints: from file extensions and imports in changed files - Existing drafts: to avoid duplicates ### Step 1: Parse Input Extract from the prompt: 1. **Topic:** What to document (e.g., "authentication middleware") 2. **Content type:** Detect from keywords: | Keywords | Type | Skill | |----------|------|-------| | "how to", "guide", "steps", "configure", "set up" | How-To | `howto-docs` | | "API", "reference", "paramete...

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

Data & Documents Listed

create-doc

Create documentation based on user needs. Use when writing guides, API docs, architecture docs, or any project documentation.

65 Updated 2 weeks ago
avibebuilder
AI & Automation Listed

write-docs

Generate documentation from a codebase — READMEs, API references, setup guides, runbooks, architecture docs, ship logs, release notes (CHANGELOG + GitHub Release bodies). Not for specifying what to build (use discover), restructuring code (use clean-code), or task decomposition (use breakdown-tasks).

10 Updated today
hungv47
AI & Automation Listed

doc-craft

Write documentation that engineers actually read — READMEs that get you running in under 5 minutes, API docs with executable examples, inline JSDoc/TSDoc/docstrings that explain the why. No corporate filler, no "this function does what its name says", no AI-generated cadence. Use when the user says "write a README", "document this", "add docstrings", "write the API docs", "write a CHANGELOG", or hands over a module and asks for docs.

0 Updated 3 days ago
ashishkumar14
AI & Automation Listed

doc-craft

Write documentation that engineers actually read — READMEs that get you running in under 5 minutes, API docs with executable examples, inline JSDoc/TSDoc/docstrings that explain the why. No corporate filler, no "this function does what its name says", no AI-generated cadence. Use when the user says "write a README", "document this", "add docstrings", "write the API docs", "write a CHANGELOG", or hands over a module and asks for docs.

0 Updated 3 days ago
ak-ship
AI & Automation Listed

doc-writer

Write, update, or review documentation (README, ARCHITECTURE.md, API docs, guides). Use after implementing features to document new APIs, CLI commands, or behavior changes.

2 Updated today
wpfleger96