* 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
1.1 KiB
1.1 KiB
cmux Documentation
Documentation website for cmux, built with Fumadocs and Next.js.
Development
# Install dependencies
npm install
# Start dev server
npm run dev
Open http://localhost:3000 to view the docs.
Deployment
This site is deployed to Vercel. Push to main to trigger a deployment.
Manual Deploy
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
- Create a new
.mdxfile incontent/docs/ - Add frontmatter with title and description
- Add the page to
content/docs/meta.json
Example:
---
title: My Page
description: Description of my page
---
# My Page
Content here...