docs

Generate Mintlify MDX documentation and update docs.json navigation for new Fair-Forge modules.

Updated May 7, 2025
One-click install
npx skills add https://github.com/Alquimia-ai/fair-forge --skill docs-alquimia-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Alquimia-ai/fair-forge/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/Alquimia-ai/fair-forge --skill docs-alquimia-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Generate Mintlify documentation automatically when new Fair Forge modules are added, ensuring consistent pages and navigation updates.

Core Features & Use Cases

  • Auto-generates MDX docs using templates when a new module is introduced.
  • Updates docs.json navigation to include new pages.
  • Generates documentation snippets for metrics, runners, generators, and storage modules.

Quick Start

Create documentation for a new module by running the docs generator with the module-type and module-name.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I auto-generate Mintlify documentation for new Fair-Forge modules?

To auto-generate Mintlify documentation for new Fair-Forge modules, run the docs generator with the module-type and module-name. This automatically creates MDX pages using templates and updates the docs.json navigation file to include the new pages.

What types of Fair-Forge modules can I generate Mintlify docs for?

You can generate Mintlify documentation snippets for metrics, runners, generators, storage backends, and core concepts. The documentation generation process applies templates to ensure consistent page creation across these specific module types.

How does automatic navigation update work when adding new module docs?

Automatic navigation update works by modifying the docs.json file to include newly generated documentation pages. When the docs generator creates MDX files for a new module, it simultaneously wires the new pages into the existing Mintlify navigation structure.

Do I need SKILL.md frontmatter to generate module documentation?

Yes, the documentation generator relies on the SKILL.md frontmatter to define the module name and description. This frontmatter provides the necessary metadata to accurately populate the Mintlify documentation templates for the new feature.

Can I use custom references and assets when generating Mintlify docs?

Yes, the documentation generation process uses standard templates located in the docs/ directory and optionally incorporates additional content from the references/ and assets/ folders as needed to enrich the generated MDX pages.

What is the best way to maintain consistent documentation across new Fair-Forge features?

The best way to maintain consistent documentation is to automate Mintlify page creation using predefined templates. This ensures every new module receives standardized MDX documentation and automatic navigation wiring without manual formatting discrepancies.