Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From cms-cultivator
Generates API docs, README files, user guides, developer guides, and changelogs by analyzing code context. Activates on mentions of documentation, README, API docs, guides, or changelogs.
npx claudepluginhub kanopi/claude-toolbox --plugin cms-cultivatorHow this skill is triggered — by the user, by Claude, or both
Slash command
/cms-cultivator:documentation-generatorThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Automatically generate documentation for code, APIs, and projects.
Generates documentation from code including API references, developer guides, READMEs, and architecture overviews. Matches existing styles and avoids overwriting in brownfield codebases.
Writes or updates documentation with code-verified accuracy for READMEs, guides, and API references. Use when creating, reviewing, or updating docs.
Share bugs, ideas, or general feedback.
Automatically generate documentation for code, APIs, and projects.
Good documentation is as critical as good code.
Activate this skill when the user:
Before generating documentation, determine:
Check for:
User requests documentation
↓
Identify documentation type
↓
Determine audience (dev/user/contributor)
↓
Check for existing docs
↓
Assess scope (function/module/project)
↓
Generate appropriate documentation
↓
Format for platform (CMS-specific if needed)
API Documentation - For code interfaces:
README - For project overview:
User Guide - For end users:
Developer Guide - For contributors:
Changelog - For releases:
For API Docs:
For README:
For Guides:
Complete templates are available for reference:
Use these templates as starting points, customizing for the specific project needs.
For comprehensive documentation sites, use Zensical - a modern static site generator from the creators of Material for MkDocs.
Install:
pip install zensical
Create new project:
zensical new my-documentation
Configuration (zensical.toml):
[project]
site_name = "Project Name"
site_description = "Brief description"
site_url = "https://yoursite.github.io/project/"
docs_dir = "docs"
site_dir = "site"
nav = [
{"Home" = "index.md"},
{"Getting Started" = [
"installation.md",
"quick-start.md"
]},
{"API Reference" = "api/index.md"}
]
[project.theme]
variant = "modern"
Build and serve:
# Local preview
zensical serve
# Production build
zensical build --clean
GitHub Actions deployment:
name: Deploy Documentation
on:
push:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- run: pip install zensical
- run: zensical build --clean
- uses: actions/upload-pages-artifact@v4
with:
path: ./site
Ask clarifying questions:
For API docs:
Follow standard patterns:
Include:
This skill complements the /docs-generate slash command:
This Skill: Automatically triggered during conversation
/docs-generate Command: Explicit batch generation
When user shows a class or function:
When user asks for project documentation:
When user needs end-user documentation:
When user needs version history:
Example 1: API documentation
User: "I need to document this service class"
[Shows DataProcessor class]
Skill: "I'll generate API documentation for your DataProcessor service.
I see it has 3 public methods and uses dependency injection.
I'll create docblocks with:
- Class description with usage example
- Constructor documentation
- Method documentation with @param and @return
- @code examples for each method
[Generates documented code following Drupal standards]
This follows Drupal documentation standards. Each method includes
parameter types, return types, and usage examples."
Example 2: README
User: "Need a README for my custom module"
Skill: "I'll create a comprehensive README for your module.
Let me check the project structure...
I see:
- Drupal 10 module
- Composer-based
- Custom services and admin routes
I'll generate a README with:
- Installation via Composer
- Feature list
- Configuration steps
- API usage examples
- Links to extended docs
[Generates README.md]"
Example 3: Changelog Entry
User: "What should I add to CHANGELOG for this release?"
Skill: "Based on your recent commits, I'll generate a changelog entry
following Keep a Changelog format:
## [1.2.0] - 2025-01-15
### Added
- User profile export functionality (#234)
- Bulk operations support
### Changed
- Improved query performance (30% faster)
### Fixed
- Permission check on admin pages (#145)
Would you like me to add this to your CHANGELOG.md?"
When generating markdown documentation for Zensical sites (like this plugin's documentation), follow these guidelines for proper rendering:
DON'T:
1. **Category Name**
- Sub-item 1
- Sub-item 2
DO:
### Category Name
- Sub-item 1
- Sub-item 2
DON'T:
**Section Title:**
- Item 1
- Item 2
DO:
#### Section Title
- Item 1
- Item 2
# - Document title (once at top)## - Major sections### - Subsections#### - Categories, steps, or sub-subsectionsDON'T:
1. **Step Name**: Description
- Detail 1
- Detail 2
DO:
#### 1. Step Name
Description
- Detail 1
- Detail 2
Complete style guide: See Markdown Style Guide for full details and examples.