doc-gen
SolidGenerate documentation for code
AI & Automation 148 stars
60 forks Updated today Apache-2.0
Install
Quality Score: 82/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Doc Gen
Generate clear, structured documentation for a codebase or module.
## Instructions
1. Use overview and find_files to understand the project structure, entry points, and module organization.
2. Read key files: entry points, public APIs, configuration, and type definitions.
3. Generate documentation covering these sections:
- **Purpose**: What the project or module does and the problem it solves.
- **Architecture**: High-level structure, key components, and how they interact.
- **API Reference**: Public functions, classes, and methods with parameters, return types, and descriptions.
- **Usage Examples**: Practical code snippets showing common use cases.
- **Configuration**: Available options, environment variables, and defaults.
4. Match the documentation style to existing docs in the project if any exist.
5. Use accurate type signatures and parameter descriptions extracted from the source code.
6. Write the documentation to markdown files in the appropriate location (e.g., docs/ directory or alongside the source).
7. Keep language concise and scannable. Use headings, bullet points, and code blocks.
8. Do not invent behavior. Document only what the code actually does.
Details
- Author
- prapaa-ai
- Repository
- prapaa-ai/agav
- Created
- 1 months ago
- Last Updated
- today
- Language
- TypeScript
- License
- Apache-2.0
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Listed
doc-gen
Use when code lacks documentation and you need to generate accurate docstrings, README sections, or API reference text derived from the implementation.
1 Updated 2 months ago
NSBen AI & Automation Listed
generate-doc
Generate documentation — README, API docs, technical docs, changelogs, and usage guides. Use when the user needs new documentation created or template-based document generation.
1 Updated 1 months ago
AVA-2568 AI & Automation Listed
doc-gen
Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen.
10 Updated 5 days ago
Smart-AI-Memory