Docs

To generate technical documentation from a codebase, you invoke a workflow that analyzes your project source code and outputs a structured docs directory with architecture, API reference, setup, and deployment guides.

Yes, you can generate architecture diagrams using Mermaid by analyzing the codebase structure. The workflow renders component relationships and architecture diagrams directly within the generated documentation files.

Yes, documentation generation works with JHipster and MuleSoft foundations, alongside Default types. It loads foundation-specific templates to ensure the generated architecture and API reference docs match your project framework.

The best way to document API references for an existing project is to use a codebase analysis workflow that references your API specs and automatically generates an API reference section within a dedicated docs directory.

You create a navigation README for project documentation by running a codebase analysis workflow that auto-generates a main README file to navigate the architecture, setup, and deployment documentation in the output directory.