frappe-documentation-generator

What problem does it solve?

Manually writing and maintaining comprehensive documentation for Frappe applications, including APIs, user guides, and technical specifications, is a time-consuming and often overlooked task. This Skill automates documentation generation.

Core Features & Use Cases

• API Documentation: Generate detailed documentation for whitelisted methods, including arguments, return values, potential errors, and usage examples.
• OpenAPI Specification: Create OpenAPI/Swagger YAML specifications for Frappe REST APIs, enabling easy integration with API testing and client generation tools.
• User Guides: Generate Markdown-based user guides for DocTypes, workflows, and key features, explaining usage and best practices for end-users.
• Use Case: Generate an OpenAPI specification for all custom API endpoints in your Frappe app, and a user guide for the 'Project' DocType, explaining how to create and manage projects.

Quick Start

Generate API documentation for the get_customer_details whitelisted method in my Frappe app, including its parameters, return values, and an example.