Skip to main content

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is the documentation repository for Chamber, a GPU capacity control plane for enterprise AI infrastructure. It uses Mintlify as the documentation framework with MDX formatting.

Development Commands

# Install Mintlify CLI (one-time setup)
npm i -g mintlify

# Start local development server with hot reload
mintlify dev

# View at http://localhost:3000

Deployment

Changes pushed to main are automatically deployed via Mintlify’s GitHub integration. No manual build step required.

Architecture

Content Organization

  • concepts/ - Core concepts (teams, capacity pools, reservations, workload classes, scheduling)
  • platform/ - Platform UI guides (dashboard, team management, capacity management, workloads)
  • agent/ - Kubernetes agent documentation (installation, troubleshooting, upgrading)
  • api-reference/ - API documentation
  • cli/ - CLI documentation

Configuration

  • docs.json - Main Mintlify config (navigation structure, theme, colors, navbar)
  • Navigation is defined in docs.json under navigation.tabs

Adding New Pages

  1. Create .mdx file in appropriate directory
  2. Add frontmatter with title and description
  3. Add page path to docs.json navigation section

MDX Components

Available Mintlify components for documentation pages:
<Card title="Title" icon="icon-name" href="/path">Content</Card>
<CardGroup cols={2}>...</CardGroup>
<Steps><Step title="Step 1">Content</Step></Steps>
<Tabs><Tab title="Tab 1">Content</Tab></Tabs>
<Accordion title="Expandable">Hidden content</Accordion>
<Tip>Tip text</Tip>
<Info>Info text</Info>
<Warning>Warning text</Warning>
<Note>Note text</Note>

Frontmatter Format

Every .mdx page requires:
---
title: "Page Title"
description: "Brief description of the page content"
---