create-documentation

Generate MDX documentation pages with Fumadocs components and meta.json navigation updates.

14.3k|3.0k|Updated Mar 12, 2023
One-click install
npx skills add https://github.com/documenso/documenso --skill create-documentation-documenso
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-documentation
Source: https://github.com/documenso/documenso/tree/main/.agents/skills/create-documentation
Command: npx skills add https://github.com/documenso/documenso --skill create-documentation-documenso

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Turning code, features, and configuration into clear, consistent documentation for different audiences is time-consuming and error-prone. This Skill provides a reproducible process and conventions for producing MDX documentation that fits Documenso's site structure and style guidelines, reducing reviewer friction and ensuring navigation consistency.

Core Features & Use Cases

  • Audience-aware guides: Produce docs tailored for Users, Developers, or Self-Hosters with the correct placement under apps/docs/content/docs/.
  • Fumadocs & MDX compliance: Ensure frontmatter, recommended imports, callouts, steps, and tabs follow the project's Fumadocs patterns and WRITING_STYLE.md.
  • Navigation updates: Create new pages and add entries to the appropriate meta.json so the docs site navigation remains consistent.
  • Source-driven content: Read relevant source files and existing docs to generate accurate API, deployment, or UI workflow documentation.

Quick Start

Create a new MDX doc in apps/docs/content/docs/developers/my-feature with proper frontmatter and Fumadocs components, base content on the source under apps/, and add the page slug to the appropriate meta.json.

Frequently Asked Questions about create-documentation

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

FAQPage Schema
How do I generate MDX documentation for a new feature?

To generate MDX documentation, you create pages under apps/docs/content/docs/ with proper frontmatter, use Fumadocs components for formatting, and update meta.json to maintain navigation consistency.

What is the correct file structure for self-hosting docs in Documenso?

Self-hosting docs in Documenso require placing MDX files under apps/docs/content/docs/ with correct frontmatter and adding page slugs to meta.json so the docs site navigation remains consistent.

How do I add a new page to Fumadocs navigation?

Adding a new page to Fumadocs navigation requires creating the MDX file with proper frontmatter and then updating the appropriate meta.json file with the new page slug to ensure the docs site navigation stays consistent.

Does this documentation workflow support audience-specific content?

Yes, the documentation workflow supports audience-specific content by tailoring guides for Users, Developers, or Self-Hosters and placing them in the correct directories under apps/docs/content/docs/.

Can I use Fumadocs components like callouts and tabs in MDX files?

Yes, you can use Fumadocs components like callouts, steps, and tabs in MDX files, ensuring they follow the project's Fumadocs patterns and WRITING_STYLE.md guidelines for consistent documentation.

What's the best way to create developer documentation from source code?

The best way to create developer documentation from source code is to read relevant source files under apps/ and generate accurate MDX pages with proper frontmatter and Fumadocs components.