How to Use Mintlify

Getting started with Mintlify

In this guide, you will learn how to set up Mintlify and start creating AI-powered documentation for your projects. By the end, you'll be able to generate documentation from your code and enhance it with AI suggestions.

Step 1: Sign up and set up

1. Go to mintlify.com.
2. Click on the "Get Started for Free" button on the homepage.
3. Fill in your email and create a password, or sign up using your GitHub account for easier integration.
4. Once signed up, you will be directed to your dashboard. Here, you can connect your GitHub account by clicking on "Connect GitHub" in the settings menu.

Step 2: Your first documentation project

1. On your dashboard, click the "New Project" button.
2. Name your project and select whether it will be public or private.
3. Choose the repository you want to document from the list of connected GitHub repos.
4. Click "Create Project". Mintlify will start generating documentation based on your code automatically.
5. To edit the documentation, click on the project name in your dashboard, then click on "Edit" next to any section to refine the content and add AI-generated suggestions.

Step 3: Get better results

1. Use the "AI Suggestions" feature by clicking on the lightbulb icon in the editing view. This will provide you with enhancement ideas for clarity and structure.
2. Regularly update your documentation by syncing with your GitHub repository using the "Sync" button on the project page.
3. Use the search bar at the top of the project page to quickly find specific sections or topics within your documentation.

Pro tip

To save time, create templates for common documentation types (like API references or onboarding guides) within Mintlify. This way, you can quickly generate new documentation without starting from scratch each time.

Common mistake to avoid

Avoid neglecting to sync your documentation with your GitHub repository. Failing to do this can result in outdated information, making your docs less reliable for your team. Remember to click the "Sync" button regularly to keep everything up to date.