skills.rest
Venkateshvenki404224
Venkateshvenki404224COMMUNITY
Explore all skills by this author →
GitHub

frappe-documentation-generator

Generate API documentation, user guides, and OpenAPI YAML specifications for Frappe apps.

25|14|Updated Dec 15, 2025
Search Tags:#documentation#technical writing#OpenAPI#Swagger#API docs#user guide#frappe#ERPNext
One-click install
npx skills add https://github.com/Venkateshvenki404224/frappe-apps-manager --skill frappe-documentation-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: frappe-documentation-generator
Source: https://github.com/Venkateshvenki404224/frappe-apps-manager/tree/main/frappe-apps-manager/skills/frappe-documentation-generator
Command: npx skills add https://github.com/Venkateshvenki404224/frappe-apps-manager --skill frappe-documentation-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about frappe-documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation for Frappe whitelisted methods?▼

API documentation generation extracts whitelisted function signatures, parameters, return values, and errors from your Frappe app, formatting them with usage examples and type information for developers integrating with your endpoints.

Can I create an OpenAPI specification for my Frappe REST APIs?▼

Yes. OpenAPI/Swagger YAML specification generation converts your Frappe REST API endpoints into structured OpenAPI format, enabling compatibility with API testing tools, client code generators, and API documentation platforms.

What's the best way to document DocTypes and workflows for end-users?▼

User guide generation produces Markdown documentation for DocTypes and workflows, explaining field purposes, relationships, and operational procedures in non-technical language tailored for end-user understanding and adoption.

Does this work with custom Frappe applications and ERPNext?▼

Documentation generation applies to custom Frappe apps and ERPNext deployments, extracting and formatting documentation from your application's whitelisted methods, DocTypes, and workflows following Frappe conventions.

What documentation formats does it produce?▼

The Skill outputs Markdown user guides for non-technical documentation, YAML OpenAPI specifications for API integration and testing, and structured docstrings embedded in your codebase for developer reference.

Can I use this if I haven't formally documented my API endpoints yet?▼

Yes. Documentation generation inspects your existing whitelisted functions and DocType definitions directly, extracting structure and metadata to build documentation without requiring pre-written specifications or comments.

Related Skills

Explore More Content & Communication Skills→
Snowflake-LabsSnowflake-Labs
12

read-ors-configuration

A concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
slantviewslantview
1

api-documenter

Generate OpenAPI specifications, SDKs, and interactive API documentation.

Community
Intermediate
pradyumnasagarpradyumnasagar
6

roadmap-author

Guide authors through creating and validating ORS SKILL.md files.

Community
Intermediate