docs

Solid

Generates/updates README, API docs, architecture notes. Triggers: docs, README, API docs, architecture note, documentation.

AI & Automation 155 stars 19 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
73
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Generate Documentation $ARGUMENTS Generate or update documentation. ## Usage ``` /docs [type] [target] ``` ## What This Command Does 1. **Analyzes** code structure 2. **Extracts** documentation info 3. **Generates** documentation files 4. **Updates** existing docs ## Documentation Types | Type | Description | |------|-------------| | `readme` | Generate/update README | | `api` | API documentation | | `architecture-note` | Architecture note | | `changelog` | Generate changelog | | `comments` | Add code comments | | `kb` | Knowledge base entry (enforces KB structure) | ## KB Document Rules (MANDATORY) When creating or updating documents in the `kb/` directory, follow the `documentation-standards` knowledge skill (auto-loaded). Key rules: - **7 required frontmatter fields:** title, category, service, tags, created, last_updated, description - **6 valid categories:** reference, howto, procedures, troubleshooting, best-practices, planning - **Category must match directory** (e.g., `category: howto` → `kb/howto/`) - **English only.** No exceptions. - **validate.sh rejects docs without valid frontmatter.** Full spec: see `app/skills/documentation-standards/SKILL.md`. ## Templates ### README Generation ```markdown # [Project Name] [Auto-generated description] ## Installation [Detected from package manager] ## Usage [Extracted from code/examples] ## API [Extracted from code] ## License [Detected] ``` ### Architecture Note Template ```markdown # Architecture Note:...

Details

Author
softspark
Repository
softspark/ai-toolkit
Created
2 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category