moai-docs-generation

Generate documentation patterns for Sphinx, MkDocs, TypeDoc, and Nextra.

Updated Jan 16, 2026
One-click install
npx skills add https://github.com/yarang/fastapi-error-code --skill moai-docs-generation-yarang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/yarang/fastapi-error-code/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/yarang/fastapi-error-code --skill moai-docs-generation-yarang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides pattern-based documentation templates to streamline the creation of API references, design specs, user guides, and knowledge bases directly from code and schemas.

Core Features & Use Cases

  • Pattern-driven templates: Predefined OpenAPI/OpenAPI-like docs, API references, and design doc templates compatible with Sphinx, MkDocs, TypeDoc, and Nextra.
  • Multi-tool compatibility: Enables consistent documentation patterns across major tooling ecosystems (Python, TypeScript, static-site generators).
  • Use Case: Teams can auto-generate starter docs from code annotations and schemas, then tailor content for stakeholders.

Quick Start

Use moai-docs-generation to scaffold a starter documentation pattern for a new project.

Frequently Asked Questions about moai-docs-generation

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

FAQPage Schema
How do I generate API references and developer guides from code?

Generate API references and developer guides from code by applying pattern-based documentation templates that scaffold references, design specs, and knowledge bases directly from codebases and schemas.

Can I use the same documentation patterns across MkDocs, Sphinx, TypeDoc, and Nextra?

Yes, you can use the same documentation patterns across MkDocs, Sphinx, TypeDoc, and Nextra, as this approach provides multi-tool compatibility to maintain consistent docs across Python, TypeScript, and static-site ecosystems.

What is the best way to scaffold starter docs for a new technical project?

The best way to scaffold starter docs for a new technical project is to auto-generate pattern-driven templates from code annotations and schemas, then tailor the content for specific stakeholders.

Does this documentation generation approach enforce specific metadata formats?

Yes, this documentation generation approach enforces YAML frontmatter with name and description fields in SKILL.md, using a Markdown body for operational instructions and supporting optional resources like scripts and references.

What types of documentation can I auto-generate from code schemas?

You can auto-generate API references, design specifications, user guides, and knowledge bases from code schemas using predefined OpenAPI-like templates compatible with major documentation tooling ecosystems.