9817d131f8
* Rename cmuxterm to cmux across entire codebase - Rename GitHub repos: manaflow-ai/cmuxterm -> manaflow-ai/cmux, manaflow-ai/homebrew-cmuxterm -> manaflow-ai/homebrew-cmux - Rename bundle IDs: com.cmuxterm.app -> com.cmux.app - Rename CLI: CLI/cmuxterm.swift -> CLI/cmux.swift - Rename homebrew submodule: homebrew-cmuxterm -> homebrew-cmux - Update all socket paths: /tmp/cmuxterm*.sock -> /tmp/cmux*.sock - Update all GitHub URLs, DMG names, Sparkle URLs - Update all source files, scripts, tests, docs, CI workflows * Bump version to 1.23.0
58 lines
1.1 KiB
Markdown
58 lines
1.1 KiB
Markdown
# cmux Documentation
|
|
|
|
Documentation website for [cmux](https://github.com/manaflow-ai/cmux), built with [Fumadocs](https://fumadocs.vercel.app) and Next.js.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Start dev server
|
|
npm run dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) to view the docs.
|
|
|
|
## Deployment
|
|
|
|
This site is deployed to Vercel. Push to main to trigger a deployment.
|
|
|
|
### Manual Deploy
|
|
|
|
```bash
|
|
npm run build
|
|
npx vercel --prod
|
|
```
|
|
|
|
## Structure
|
|
|
|
```
|
|
docs-site/
|
|
├── app/ # Next.js app router
|
|
│ ├── docs/ # Documentation pages
|
|
│ └── page.tsx # Landing page
|
|
├── content/
|
|
│ └── docs/ # MDX documentation files
|
|
└── lib/
|
|
└── source.ts # Fumadocs source configuration
|
|
```
|
|
|
|
## Adding Documentation
|
|
|
|
1. Create a new `.mdx` file in `content/docs/`
|
|
2. Add frontmatter with title and description
|
|
3. Add the page to `content/docs/meta.json`
|
|
|
|
Example:
|
|
|
|
```mdx
|
|
---
|
|
title: My Page
|
|
description: Description of my page
|
|
---
|
|
|
|
# My Page
|
|
|
|
Content here...
|
|
```
|