Skip to main content
Prerequisite: You should have installed Node.js (version 20 or higher) and cloned the Tuturuuu Monorepo to your local machine.
Step 1. Install Mintlify on your local machine: 
bun i -g mintlify
Step 2. Go to the docs are located (navigate to apps/docs) and run the following command: 
mintlify dev
The documentation website is now available at http://localhost:3000.
Use cd apps/docs to navigate to the docs folder.

​
Custom Ports

Mintlify uses port 3000 by default. You can use the --port flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: 
mintlify dev --port 3333
You will see an error like this if you try to run Mintlify in a port that’s already taken: 
Error: listen EADDRINUSE: address already in use :::3000

​
Mintlify Versions

Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. 
bun i -g mintlify@latest

​
Writing Documentation

​
File Structure

Each documentation file should follow this structure: 
---
title: "Page Title"
description: "Brief description of the page content"
updatedAt: "YYYY-MM-DD"
---

# Page Title

Content goes here...

​
Content Guidelines

  1. Use clear headings to structure your content
  2. Include code examples with proper syntax highlighting
  3. Add cross-references to related documentation
  4. Keep content up-to-date by updating the updatedAt field
  5. Use consistent formatting throughout

​
Code Examples

When including code examples:
  • Use proper syntax highlighting
  • Include TypeScript types
  • Show both server and client examples
  • Include error handling
  • Test examples before committing

​
Images and Assets

  • Store images in the images/ directory
  • Use descriptive filenames
  • Optimize images for web
  • Include alt text for accessibility

​
Contributing

​
Before You Start

  1. Check if documentation already exists
  2. Look for similar patterns in existing docs
  3. Follow the established structure
  4. Read the Organization Guide for structure

​
Making Changes

  1. Create a branch for your documentation changes
  2. Write clear, concise content that’s easy to understand
  3. Include practical examples that developers can use
  4. Update related documentation if needed
  5. Test your changes locally with mintlify dev

​
Review Process

  1. Self-review your changes for clarity and accuracy
  2. Check links to ensure they work correctly
  3. Verify code examples are correct and complete
  4. Update the table of contents if adding new sections
  5. Submit a pull request with a clear description

​
Best Practices

​
Writing Style

  • Be concise but comprehensive
  • Use active voice when possible
  • Write for your audience (developers)
  • Include context for complex topics
  • Use consistent terminology throughout

​
Organization

  • Group related content together
  • Use clear section headings
  • Include a table of contents for long pages
  • Cross-reference related documentation
  • Keep examples practical and realistic

​
Maintenance

  • Update documentation when APIs change
  • Remove outdated information promptly
  • Keep examples current with latest versions
  • Review documentation regularly for accuracy
  • Ask for feedback from other developers