create-documentation

Generate MDX-ready documentation from source code with structured sections.

236|234|Updated Feb 21, 2026

Search Tags:#documentation #frontend #navigation #mdx #writing-guidelines #docs-generation

Ready to run

npx skills add https://github.com/Karanjot786/TermUI --skill create-documentation-karanjot786

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-documentation
Source: https://github.com/Karanjot786/TermUI/tree/main/.claude/skills/create-documentation
Command: npx skills add https://github.com/Karanjot786/TermUI --skill create-documentation-karanjot786

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineering teams create accurate, well-structured Markdown documentation for a feature or module.

Core Features & Use Cases

Generates Markdown documentation from code and existing sources following the project's writing guidelines.
Reads source code and existing docs to ensure consistency and up-to-date references.
Updates navigation meta and ensures MDX-ready content for the docs site.

Quick Start

Provide MDX-ready documentation for the specified feature, including purpose, usage, and API surface.

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 from source code?▼

Generate MDX documentation from source code by reading the feature's source files and applying a consistent structure with problem, features, and quick start sections. The output aligns with the project's writing guidelines and updates navigation metadata.

What is the best way to write frontend docs that match existing writing guidelines?▼

Writing frontend docs that match existing guidelines requires reading current source code and repository docs to ensure consistency. The documentation generation process applies the project's established structure and produces MDX-ready content.

How do I update navigation metadata when adding new module documentation?▼

Updating navigation metadata when adding module documentation happens automatically during generation. The process reads the repository's documentation framework and produces MDX output configured to update the site's navigation references.

Can I use this to create documentation for a specific feature without manual writing?▼

Yes, you can create feature documentation without manual writing. The skill identifies the specific feature to document, reads its source code, and generates structured MDX-ready content including the API surface and usage examples.

Does generated documentation follow a specific structure for the problem and quick start sections?▼

Generated documentation follows a specific structure that includes dedicated sections for the problem, features, and quick start. This consistent structure aligns with the repository's writing guidelines and produces MDX-ready output.

Why do I need MDX-ready content for my docs site?▼

You need MDX-ready content to integrate documentation seamlessly into modern frontend docs sites. The generated output adheres to the repository's documentation framework, ensuring the new feature pages render correctly and maintain navigation consistency.