From 0a0fa1742a1591b42493518f2bb4c6b29134a055 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:12:43 +0000 Subject: [PATCH 1/5] Update quickstart.mdx --- quickstart.mdx | 51 +++++++++++++------------------------------------- 1 file changed, 13 insertions(+), 38 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index a93e523e7..0de9c5815 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,17 +4,15 @@ description: "Deploy your documentation site and make your first changes." keywords: ["quickstart", "deploy", "get started", "first steps"] --- -After completing this guide, you will have a live documentation site ready to customize and expand. - -**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 +## Your documentation site -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +After onboarding, your site is live at: ``` https://.mintlify.app @@ -27,50 +25,27 @@ 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 +## Connect GitHub -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +Install the GitHub App to automate 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. Go to **Settings** → **GitHub App** in your dashboard. +2. Select **Install GitHub App** and choose your organization. +3. Select the repositories to connect. GitHub App Installation GitHub App Installation - - Update the GitHub App permissions if you move your documentation to a different repository. - +Then authorize your account: -### Authorize your GitHub account +1. Go to **Settings** → **My Profile**. +2. Select **Authorize 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. +## Choose your workflow - - 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: - - - For users who prefer working with existing tools in their local environment. Click to jump to this section. - - - - For users who prefer a visual interface in their web browser. Click to jump to this section. - +Pick the workflow that fits your team: ## Code-based workflow From fa86f07f8ac93f4c6af397692ee56867763665c8 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:12:56 +0000 Subject: [PATCH 2/5] Update quickstart.mdx --- quickstart.mdx | 50 ++++++++++---------------------------------------- 1 file changed, 10 insertions(+), 40 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 0de9c5815..b997af4de 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -47,17 +47,11 @@ Then authorize your account: Pick the workflow that fits your team: -## Code-based workflow +### 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 code editor and Git. -### Install the CLI - - - **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. - - -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 CLI** (requires [Node.js](https://nodejs.org/en) v19+): ```bash npm @@ -69,25 +63,13 @@ To work locally with your documentation, install the Command Line Interface (CLI ``` -### Create a new project - -Run `mint new` to create a new documentation project. See the [CLI installation guide](/installation#create-a-new-project) for details on the command and flags. +**Create a project**: -### Edit the documentation - -After setting up your project, you can start editing your documentation files. For example, update the title of the introduction page: - -1. Navigate to your documentation repository. -2. Open `index.mdx` and locate the top of the file: - -```mdx index.mdx ---- -title: "Introduction" -description: "This is the introduction to the documentation" ---- +```bash +mint new ``` -3. Update the `title` field to `"Hello World"`. +**Edit your docs**. Open `index.mdx` and change the title: ```mdx index.mdx {2} --- @@ -96,32 +78,20 @@ description: "This is the introduction to the documentation" --- ``` -### Preview the changes - -To preview the changes locally, run the following command: +**Preview locally**: ```bash mint dev ``` -Your preview is available at `localhost:3000`. +Your preview is at `localhost:3000`. 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. - +**Push to deploy**. Mintlify automatically builds and deploys your changes. ## Web editor workflow From 593c32be55ba8828b1644581787fea031234cfee Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:13:08 +0000 Subject: [PATCH 3/5] Update quickstart.mdx --- quickstart.mdx | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b997af4de..2ffec3287 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -93,31 +93,21 @@ Your preview is at `localhost:3000`. **Push to deploy**. Mintlify automatically builds and deploys your changes. -## Web editor workflow +### 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 directly in your browser with a visual interface. -### Access the web editor +**Open the editor**: -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. - +1. Go to your [dashboard](https://dashboard.mintlify.com). +2. Select **Editor** in the sidebar. 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". +**Edit your docs**. Select `index.mdx` and update the title to "Hello World". Editing in Web Editor @@ -125,18 +115,12 @@ Then, in the editor, update the title field to "Hello World". - The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools. + Type / to open the command menu and access formatting 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. - +**Publish**. Click the **Publish** button to deploy your changes. -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). +Learn more in the [web editor documentation](/editor). ## Adding a custom domain From 4b2653d036e3a96dd049ca8a422da8d9d718ef33 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:13:19 +0000 Subject: [PATCH 4/5] Update quickstart.mdx --- quickstart.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 2ffec3287..ac5fb0715 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -122,27 +122,25 @@ Edit directly in your browser with a visual interface. Learn more in the [web editor documentation](/editor). -## Adding a custom domain +## Add a custom domain -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. - -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +Go to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) 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. +Enter your domain (e.g., `docs.yourcompany.com`) and add this DNS record: | Record Type | Name | Value | TTL | |-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 | +| CNAME | docs | cname.vercel-dns.com | 3600 |
- DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. + DNS changes can take up to 48 hours to propagate. ## Next steps From 611b9345b5f58e0e678f15be8e1efa5bfd909544 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:13:34 +0000 Subject: [PATCH 5/5] Update quickstart.mdx --- quickstart.mdx | 36 +++++++++--------------------------- 1 file changed, 9 insertions(+), 27 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index ac5fb0715..b6e48815f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -145,36 +145,18 @@ Enter your domain (e.g., `docs.yourcompany.com`) and add this DNS record: ## Next steps -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: - - - 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. + + Change colors, fonts, and appearance. - Structure your documentation with intuitive navigation to help users find what they need. + Structure your documentation for easy navigation. - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Use interactive components like accordions and tabs. - - Create interactive API references with OpenAPI and AsyncAPI specifications. + + Create API references with OpenAPI specifications. - -## 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. - - - Deployment can take up 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. - - - 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. - -