Contributing to Documentation

This project uses Fumadocs for documentation. The docs are integrated into the main application and served at /docs.

Documentation Structure

packages/docs/
├── content/
│   └── docs/          # MDX documentation files
│       ├── index.mdx
│       ├── architecture.mdx
│       ├── design-choices.mdx
│       ├── future-plans.mdx
│       └── contributing.mdx
├── source.config.ts   # Fumadocs configuration
└── package.json

Adding New Documentation

1. Create a New MDX File

Create a new .mdx file in packages/docs/content/docs/:

touch packages/docs/content/docs/your-topic.mdx

2. Add Frontmatter

Every documentation page needs frontmatter with title and description:

---
title: Your Topic Title
description: A brief description of what this page covers
---

# Your Topic Title

Your content here...

3. Write Content

Use standard Markdown with MDX enhancements:

Code Blocks

// Code blocks support syntax highlighting
export function example() {
  return "Hello, world!";
}

Callouts

Use blockquotes for callouts:

Note: This is an informational callout.

Lists and Tables

Standard Markdown lists and tables are supported.

4. Regenerate Docs

After adding or editing docs, regenerate the source files:

# From root
bun run docs:generate

# Or from web app
cd apps/web
bun run fumadocs-mdx

The dev server will automatically regenerate docs when you save changes.

Editing Existing Documentation

Navigate to packages/docs/content/docs/
Edit the .mdx file you want to change
Save the file
The dev server will hot-reload the changes

Documentation Best Practices

Writing Style

Be concise: Get to the point quickly
Use examples: Show code examples where relevant
Be consistent: Follow the existing documentation style
Update regularly: Keep docs in sync with code changes

File Naming

Use kebab-case: my-topic.mdx
Be descriptive: database-migrations.mdx not db.mdx
Group related topics in subdirectories if needed

Frontmatter Guidelines

---
title: Clear, Descriptive Title
description: One sentence summary (50-160 characters)
---

Fumadocs Features

Syntax Highlighting

Code blocks automatically get syntax highlighting with light/dark theme support:

bun install
bun run dev

import { auth } from '@info-ppaai-app/auth';

export async function getUser() {
  const session = await auth.api.getSession();
  return session?.user;
}