Development Guide
Learn how to set up, develop, and deploy CallIntel LiveKit documentation locally.Prerequisites
- Node.js version 19 or higher
- npm or yarn package manager
- Git for version control
- A text editor (VS Code recommended)
Installation
Install Mintlify CLI
The Mintlify CLI is required to develop and preview documentation locally.Clone and Navigate
Verify Installation
Local Development
Preview Locally
Navigate to your docs directory and run:http://localhost:3000.
The dev server includes hot reload - changes to
.mdx files will automatically refresh your browser.Custom Port
By default, Mintlify uses port 3000. To use a different port:Documentation Structure
See/guides/documentation-guide for detailed information about the documentation structure and best practices.
Building for Production
Build Static Site
dist/ directory.
Verify Build
Editing Pages
Creating New Pages
- Create a new
.mdxfile in the appropriate directory:
- Add front matter:
- Add content using Markdown/MDX
-
Update
docs.jsonto include the new page in navigation
Updating Navigation
Editdocs.json:
MDX Components
Available Mintlify components:Linting and Validation
Lint Documentation
- Invalid Markdown
- Missing files referenced in navigation
- Broken links
Validate Configuration
docs.json structure.
Customization
Colors
Editdocs.json to customize colors:
Logo
Place SVG files indocs/logo/:
light.svg- Light mode logodark.svg- Dark mode logo
Navigation Links
Add links indocs.json:
Best Practices
Writing Quality Documentation
- Clear titles - Use descriptive, action-oriented titles
- Structure - Use headings to organize content
- Examples - Include code examples for every concept
- Screenshots - Add visuals for UI-heavy topics
- Links - Link to related documentation
- Tone - Be professional but friendly
- Updates - Keep docs in sync with code
Code Examples
Formatting
- Use bold for emphasis
- Use
codefor filenames and variables - Use code blocks for multi-line code
- Use tables for structured data
Deployment
GitHub Pages
Documentation is automatically deployed when you push tomain branch:
.github/workflows for CI/CD configuration.
Custom Domain
Updatedocs.json navbar to reflect your domain:
Troubleshooting
Dev Server Not Starting
Port Already in Use
Changes Not Appearing
- Check file is saved
- Refresh browser (or wait for hot reload)
- Check browser console for errors
- Verify file path in
docs.json
Build Errors
CI/CD Pipeline
Documentation builds and deploys automatically via GitHub Actions.Manual Deployment
Version Control
Git Workflow
Commit Messages
Use conventional commits:Performance
Optimization Tips
- Compress images before adding
- Use appropriate image formats (PNG for graphics, JPG for photos)
- Link to external resources instead of embedding
- Keep pages focused and concise
Analytics
Track documentation usage via:- Google Analytics
- Mintlify Dashboard
- Custom tracking
Support and Resources
Next Steps
Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI:Validating links
The CLI can assist with validating links in your documentation. To identify any broken links, use the following command:Troubleshooting
Error: Could not load the "sharp" module using the darwin-arm64 runtime
Error: Could not load the "sharp" module using the darwin-arm64 runtime
This may be due to an outdated version of node. Try the following:
- Remove the currently-installed version of the CLI:
npm remove -g mint - Upgrade to Node v19 or higher.
- Reinstall the CLI:
npm i -g mint