Skip to main content
After you complete this guide, you’ll have a live documentation site ready to customize and update.

​
Before you begin

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Using an AI coding tool?Copy the following prompt to add the Mintlify skill and MCP server for better results when updating your documentation.
npx skills add https://mintlify.com/docs

​
Deploy your documentation site

If your code or documentation is already in a public GitHub repository, auto-generate your documentation site instead.Replace github.com with mintlify.com in any public repository URL:
https://mintlify.com/github-org/repo-name
1

Start onboarding

Go to mintlify.com/start to begin the onboarding process.
2

Connect your GitHub account

Authorize Mintlify to access your GitHub account. This enables automatic deployments when you push changes.
3

Create or select a repository

Choose an existing repository for your documentation or create a new one. Mintlify will use this repository to store your documentation files.
You can skip connecting GitHub during onboarding if you want to get started quickly. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.
4

Install the GitHub App

Install the Mintlify GitHub App to enable automatic deployments. This allows Mintlify to detect when you push changes and rebuild your site.
5

Complete setup

After onboarding, your documentation site deploys automatically and is accessible at your .mintlify.app URL.

​
View your deployed site

Your documentation site is now deployed at https://<your-project-name>.mintlify.app. Find your exact URL on the Overview page of your dashboard.
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a custom domain.

​
Make your first change

Choose your preferred editing method to update your documentation:
1

Open the web editor

Navigate to the web editor in your dashboard.
2

Edit a page

Open the Introduction page and update the description. The web editor provides a live preview of your changes.
3

Publish your changes

Click the Publish button in the top-right of the web editor toolbar to commit and deploy your changes.
4

View live

On the Overview page of your dashboard, you can see your site’s deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
Changes pushed to your repository trigger automatic deployments. Make sure to test your changes locally before pushing to production.

​
Next steps

Now that you have a live documentation site, explore these features to enhance your docs:

Use the web editor

Edit documentation in your browser and preview how your pages look when published.

Explore CLI commands

Find broken links, check accessibility, validate OpenAPI specs, and more.

Add a custom domain

Use your own domain for your documentation site.

Customize your theme

Match your brand with custom colors, fonts, and styling options.

Build docs developers (and LLMs) love

Get started for freeTalk to us