Ruflo Docs

Features

• Automated documentation generation
• API documentation from JSDoc/TSDoc/OpenAPI
• Drift detection between code and docs
• Integration with background document worker
• Namespace coordination for drift state

Use Cases

• Automatically generate API reference docs from source code
• Detect and flag when documentation falls out of sync with code changes
• Ensure code and documentation remain consistent
• Streamline the documentation process for complex projects

Non-Goals

• Performing destructive file operations
• Managing user secrets
• Sending telemetry data over the network

Workflow

1. Identify documentation needs
2. Analyze source code for public APIs and existing docs
3. Detect drift between code and docs
4. Generate or update documentation
5. Dispatch document worker for large-scale generation

Prerequisites

• `ruflo-core` plugin
• CLI v3.6+ (for specific invocations)