Skip to main content

​
Getting Started with Choco

This guide walks you through setting up and contributing to Choco documentation.

​
Prerequisites

  • Node.js 20+
  • pnpm 9+
  • A GitHub account with access to choco-hq

​
Quick Start

1
Clone the repository
2
git clone https://github.com/choco-hq/atlas.git
cd atlas
3
Install dependencies
4
pnpm install
5
Start the development server
6
pnpm dev
7
The documentation site will be available at http://localhost:3000.
8
Make your changes
9
Edit or create .mdx files in the appropriate directory. Changes hot-reload automatically.
10
Preview and submit
11
pnpm build  # Verify the build passes
12
Open a pull request against main when ready.

​
Project Structure

atlas/
├── docs.json          # Mintlify configuration
├── index.mdx          # Home page
├── choco/             # Choco platform docs
│   ├── README.mdx     # Overview
│   ├── guide/         # Guides
│   └── domains/       # Domain strategy
├── chronicle/         # Chronicle docs
├── so1/               # SO1 Platform docs
├── sparki/            # Sparki docs
└── ...                # Other product tabs

​
Writing Guidelines

​
Frontmatter

Every page requires a frontmatter block: 
---
title: "Page Title"
description: "A brief description of the page content"
---

​
Naming Conventions

File and directory names use kebab-case. See the Naming Conventions guide for the full system.

​
Components

Mintlify provides rich MDX components:
  • <CardGroup> and <Card> for navigation cards
  • <Steps> for sequential instructions
  • <Accordion> for collapsible content
  • Mermaid diagrams via fenced code blocks

​
Next Steps