doc-component

Generate Mintlify MDX documentation pages for BEEQ components from source files.

160|24|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/Endava/BEEQ --skill doc-component-endava
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-component
Source: https://github.com/Endava/BEEQ/tree/main/.agents/skills/doc-component
Command: npx skills add https://github.com/Endava/BEEQ --skill doc-component-endava

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns incomplete or missing BEEQ component documentation into a publishable Mintlify MDX page, so you can keep docs aligned with the source code and the design system standards.

Core Features & Use Cases

  • Component API extraction: Reads the component source, custom elements manifest, and related files to capture the real props, events, slots, shadow parts, and CSS variables.
  • Structured page creation: Builds pages in the required order for introductions, examples, best practices, accessibility, API tables, and resources.
  • Docs migration and cleanup: Helps you migrate Zeroheight content, refill partial pages, and normalize tone and structure across the docs site.
  • Use case: When a new BEEQ component is ready, use this Skill to draft its documentation page from the source of truth instead of manually assembling sections from old references.

Quick Start

Ask the Skill to write the Mintlify MDX documentation page for a BEEQ component such as card or button using the component source as the source of truth.

Frequently Asked Questions about doc-component

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

FAQPage Schema
How do I generate Mintlify MDX documentation for BEEQ components?

To generate Mintlify MDX documentation for BEEQ components, the Skill reads component source files and custom elements manifests to extract props, events, slots, and CSS variables, then structures them into a complete MDX page.

What is the best way to migrate legacy Zeroheight docs to Mintlify MDX?

Migrating legacy Zeroheight docs to Mintlify MDX is handled by extracting the existing component API details and normalizing the content into the required Mintlify page structure for introductions, examples, and API tables.

Can I automatically extract props, events, and CSS variables from web component source files?

Yes, you can automatically extract props, events, shadow parts, and CSS variables directly from web component source files and custom elements manifests to ensure documentation matches the actual codebase.

What mandatory structure does a Mintlify MDX page need for a design system component?

A Mintlify MDX page for a design system component requires a structured order including introductions, examples, best practices, accessibility, API tables, and resources to meet documentation standards.

Does this documentation generator work with partially written MDX pages?

Yes, the documentation generator works with partially written MDX pages by reading the existing source code to refill missing sections and normalize the tone across the docs site.