carbon-docs

Automate Carbon documentation authoring with Fumadocs, Next.js, and Tailwind CSS.

2.3k|331|Updated Jun 3, 2024
One-click install
npx skills add https://github.com/crbnos/carbon --skill carbon-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: carbon-docs
Source: https://github.com/crbnos/carbon/tree/main/.ai/skills/carbon-docs
Command: npx skills add https://github.com/crbnos/carbon --skill carbon-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires fumadocs, next, tailwindcss, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill streamlines the process of creating, editing, and extending the Carbon documentation site. It ensures consistency in content, adheres to best practices, and provides quick access to necessary information.

Core Features & Use Cases

  • Authoring Guide and Reference Content: Create or modify narrative guides and reference materials for Carbon's extensive features and architecture.
  • Component Customization: Define custom components for guides and reference pages, ensuring a consistent and branded look and feel.
  • Documentation Verification: Automated verification against source code and database migrations ensures accuracy and up-to-date information.

Quick Start

To add a new guide chapter, use the command: use carbon-docs skill to add a guide chapter "Chapter Title" within the "Flow Name" flow.

Frequently Asked Questions about carbon-docs

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

FAQPage Schema
How do I automate Next.js documentation generation from source code?

Automate Next.js documentation generation by using a structured guide architecture and reference entity pages. This ensures consistency with real source code and database migrations for accurate API documentation.

What is the best way to manage Fumadocs content for a Next.js project?

Manage Fumadocs content by authoring narrative guides and customizing reference components. This approach ensures a branded look and feel while maintaining strict consistency with your actual source code.

Does Tailwind CSS work with Fumadocs for documentation component customization?

Tailwind CSS works with Fumadocs to define custom components for guides and reference pages. This combination provides a consistent, branded documentation site directly within your Next.js environment.

How do I add a new guide chapter to an existing Next.js documentation flow?

Add a new guide chapter by executing a targeted command to insert the narrative content within a specific flow. This creates a structured guide entry that aligns with the existing architecture.

Why should I verify database migrations against my documentation site?

Verify database migrations against your documentation site to ensure API reference pages reflect the actual database schema. Automated verification prevents outdated information and maintains strict accuracy.

Do I need specific dependencies to set up a Tailwind CSS documentation framework?

You need Fumadocs, Next.js, and Tailwind CSS to set up this documentation framework. These dependencies provide the structured architecture required to automate and manage reference content accurately.