From 4f705609f23dcdedec7b6bec8aaef10e6ca38c9b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:44:27 +0000 Subject: [PATCH 1/8] Update quickstart.mdx --- quickstart.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..64f1e167d 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,14 +4,10 @@ description: "Deploy your documentation in minutes" icon: "rocket" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. - -After completing this guide, you will have a live documentation site ready to customize and expand. +Get your documentation site live in minutes with this step-by-step guide. - -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - +**Prerequisites**: [Create an account](https://mintlify.com/start) and complete onboarding. ## Getting started From 6da46ceb71560bb3c6615dd3595a52ff7d6848ec Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:44:35 +0000 Subject: [PATCH 2/8] Update quickstart.mdx --- quickstart.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 64f1e167d..8d027a379 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -10,9 +10,9 @@ Get your documentation site live in minutes with this step-by-step guide. **Prerequisites**: [Create an account](https://mintlify.com/start) and complete onboarding. -## Getting started +## Your live site -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +After onboarding, your documentation automatically deploys to: ``` https://.mintlify.app @@ -25,8 +25,6 @@ Find your URL on the Overview page of your [dashboard](https://dashboard.mintlif Mintlify Domain -Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site. - ### Install the GitHub App Mintlify provides a GitHub App that automates deployment when you push changes to your repository. From 22165fa43421bf07690917b0ede8c489ec100f87 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:44:46 +0000 Subject: [PATCH 3/8] Update quickstart.mdx --- quickstart.mdx | 27 ++++----------------------- 1 file changed, 4 insertions(+), 23 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 8d027a379..fecdd6ed2 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -25,37 +25,18 @@ Find your URL on the Overview page of your [dashboard](https://dashboard.mintlif Mintlify Domain -### Install the GitHub App +## GitHub setup -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +Connect your GitHub repository to enable automatic deployments: -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. - -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **GitHub App** from the sidebar. -3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page. -4. Select the organization or user account where you want to install the app. -5. Select the repositories that you want to connect. +1. **Install the GitHub App**: Go to **Settings** → **GitHub App** → **Install GitHub App** +2. **Authorize your account**: Go to **Settings** → **My Profile** → **Authorize GitHub account** GitHub App Installation GitHub App Installation - - Update the GitHub App permissions if you move your documentation to a different repository. - - -### Authorize your GitHub account - -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **My Profile** from the sidebar. -3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page. - - - An admin for your GitHub organization may need to authorize your account depending on your organization settings. - - ## Editing workflows Mintlify offers two workflows for creating and maintaining your documentation: From d1cd40e49467cf7d241f33fe7b158ceb9a3f4601 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:45:01 +0000 Subject: [PATCH 4/8] Update quickstart.mdx --- quickstart.mdx | 55 ++++++-------------------------------------------- 1 file changed, 6 insertions(+), 49 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index fecdd6ed2..53f02f2ce 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -51,11 +51,11 @@ Mintlify offers two workflows for creating and maintaining your documentation: ## Code-based workflow -The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code. +Work locally with your existing development tools and Git workflow. ### Install the CLI -To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: +Install the [mint CLI](https://www.npmjs.com/package/mint) to preview changes locally: ```bash npm @@ -67,60 +67,17 @@ To work locally with your documentation, install the Command Line Interface (CLI ``` - - You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide. - - -### Edit the documentation +### Edit and preview -After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: - -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: - -```mdx index.mdx ---- -title: "Introduction" -description: "This is the introduction to the documentation" ---- -``` - -3. Update the `title` field to `"Hello World"`. - -```mdx index.mdx {2} ---- -title: "Hello World" -description: "This is the introduction to the documentation" ---- -``` - -### Preview the changes - -To preview the changes locally, run the following command: - -```bash -mint dev -``` - -Your preview will be available at `localhost:3000`. +1. Edit your documentation files (e.g., update the title in `index.mdx`) +2. Preview locally: `mint dev` (available at `localhost:3000`) +3. Push changes to deploy automatically Mintlify Dev Mintlify Dev -### Push the changes - -When you are ready to publish your changes, push them to your repository. - -Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com). - -After the deployment completes, your latest update will be available at `.mintlify.app`. - - - Optionally, skip the web editor workflow and jump to adding a custom domain. - - ## Web editor workflow The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools. From 7de3a6970ea636ee92f3abcb86e76cad02f391b1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:45:13 +0000 Subject: [PATCH 5/8] Update quickstart.mdx --- quickstart.mdx | 43 +++++++++---------------------------------- 1 file changed, 9 insertions(+), 34 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 53f02f2ce..8d1581cb1 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -80,49 +80,24 @@ Install the [mint CLI](https://www.npmjs.com/package/mint) to preview changes lo ## Web editor workflow -The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools. +Edit documentation directly in your browser with a visual interface. -### Access the web editor +### Getting started -1. Log in to your [dashboard](https://dashboard.mintlify.com). -2. Select **Editor** on the left sidebar. - - - If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor. - - - - The Mintlify web editor in the visual editor mode - The Mintlify web editor in the visual editor mode - - -### Edit the documentation - -In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: - -Find and select `index.mdx` in the file explorer. - -Then, in the editor, update the title field to "Hello World". +1. Go to your [dashboard](https://dashboard.mintlify.com) → **Editor** +2. Select any file to edit (e.g., `index.mdx`) +3. Make changes using the visual editor +4. Click **Publish** to deploy instantly - Editing in Web Editor - Editing in Web Editor + The Mintlify web editor + The Mintlify web editor - The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools. - - -### Publish your changes - -When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. - - - Use branches to preview and review changes through pull requests before deploying to your live site. +Type / to access formatting tools and components. Use branches for collaborative editing and pull request workflows. -For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor/getting-started). - ## Adding a custom domain While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. From 540d603a905daa41e625a2a9a11e4bd7b1edc6ac Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:45:24 +0000 Subject: [PATCH 6/8] Update quickstart.mdx --- quickstart.mdx | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 8d1581cb1..b40a440ab 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -98,28 +98,24 @@ Edit documentation directly in your browser with a visual interface. Type / to access formatting tools and components. Use branches for collaborative editing and pull request workflows. -## Adding a custom domain +## Custom domain (optional) -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. +Add a custom domain for production use: -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. - - - Custom Domain - Custom Domain - - -Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider. +1. Go to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) +2. Enter your domain (e.g., `docs.yourcompany.com`) +3. Add this CNAME record to your DNS: | Record Type | Name | Value | TTL | |-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | +| CNAME | docs | cname.mintlify.app | 3600 |
- - DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. - + + Custom Domain + Custom Domain + ## Next steps From ccdcae8aeb5adf1f8cee4dbba02e9add8d1604b0 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:45:33 +0000 Subject: [PATCH 7/8] Update quickstart.mdx --- quickstart.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b40a440ab..002e5c39a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -119,22 +119,22 @@ Add a custom domain for production use: ## Next steps -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +Your documentation site is live! Here's how to enhance it: - - Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. + + Customize styling, navigation, and integrations in `docs.json` - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. + + Update colors, fonts, and appearance - Structure your documentation with intuitive navigation to help users find what they need. + Structure your content with intuitive navigation - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Use interactive elements like accordions and tabs - - Create interactive API references with OpenAPI and AsyncAPI specifications. + + Create interactive API docs with OpenAPI specs ## Troubleshooting From d37bdbab6871fa561494ce719328e04dea9b549b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 08:45:43 +0000 Subject: [PATCH 8/8] Update quickstart.mdx --- quickstart.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 002e5c39a..2f21c8d80 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -139,16 +139,14 @@ Your documentation site is live! Here's how to enhance it: ## Troubleshooting -If you encounter issues during the setup process, check these common troubleshooting solutions: - - Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file. + Ensure Node.js v19+ is installed and run `mint dev` from your project directory containing `docs.json`. - Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors. + Deployments take a few minutes. Check GitHub Actions or dashboard deployment logs for build errors. - Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record. + Verify DNS records are correct and allow up to 48 hours for propagation. Use [DNSChecker](https://dnschecker.org) to verify your CNAME.