ultra-docs
Generate structured, step-by-step documentation for tasks like API endpoints or setup instructions, with customizable formats, AI providers, and options to include code examples or type information.
Instructions
Generate comprehensive documentation with step-by-step workflow
Input Schema
Name | Required | Description | Default |
---|---|---|---|
files | No | File paths to document (optional) | |
findings | No | Accumulated documentation content | |
format | No | Documentation format | markdown |
includeExamples | No | Include code examples in documentation | |
includeTypes | No | Include type information for TypeScript/Flow | |
model | No | Specific model to use | |
nextStepRequired | No | Whether another step is needed | |
provider | No | AI provider to use | |
stepNumber | No | Current step in the documentation workflow | |
task | Yes | What to document (e.g., "API endpoints", "setup instructions") | |
totalSteps | No | Estimated total steps needed |