From f2164c715b782e5c5032d7e9c881727441d21762 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 23:21:03 +0000 Subject: [PATCH 1/2] Update quickstart.mdx --- quickstart.mdx | 235 ++++++------------------------------------------- 1 file changed, 27 insertions(+), 208 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index a93e523e7..a8abd8db5 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,20 +1,13 @@ --- title: "Quickstart" 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. +[Create an account](https://mintlify.com/start) and complete onboarding to get started. - +## Deploy your site -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - - - -## Getting started - -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +After onboarding, your documentation site deploys automatically to: ``` https://.mintlify.app @@ -22,67 +15,22 @@ https://.mintlify.app Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - - Mintlify Domain - 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. - -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. - - - GitHub App Installation - GitHub App Installation - +## Make your first edit - - Update the GitHub App permissions if you move your documentation to a different repository. - +Choose your preferred workflow: -### 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: - - - 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. - +### Web editor -## Code-based workflow +1. Open the [Editor](https://dashboard.mintlify.com/editor) in your dashboard +2. Select `index.mdx` from the file explorer +3. Change the title to "Hello World" +4. Click **Publish** -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. +Your changes deploy immediately. -### Install the CLI +### Local development - - **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: ```bash npm @@ -94,160 +42,31 @@ 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. - -### 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" ---- -``` - -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 +Edit your docs: -To preview the changes locally, run the following command: +1. Run `mint new` to create a project +2. Open `index.mdx` and change the title to "Hello World" +3. Run `mint dev` to preview at `localhost:3000` +4. Push your changes to deploy -```bash -mint dev -``` +## Add a custom domain -Your preview is available at `localhost:3000`. +Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) and add your domain (e.g., `docs.yourcompany.com`). - - Mintlify Dev - Mintlify Dev - +Configure your DNS: -### 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. - -### Access the web 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. - - - - 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". - - - Editing in Web Editor - Editing in 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. - - -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). - -## 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. - -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. - - | Record Type | Name | Value | TTL | |-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 | -
- - - DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. - +| CNAME | docs | cname.vercel-dns.com | 3600 | ## 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. - - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. + + Customize your site with the `docs.json` file - Structure your documentation with intuitive navigation to help users find what they need. + Structure your documentation - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Use interactive elements - - Create interactive API references with OpenAPI and AsyncAPI 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. - - From a58423fde782bef29f7de957706f6d79e4ee4908 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 23:51:55 +0000 Subject: [PATCH 2/2] Update quickstart.mdx --- quickstart.mdx | 42 ++++++++---------------------------------- 1 file changed, 8 insertions(+), 34 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index a8abd8db5..9f88cf682 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -3,34 +3,20 @@ title: "Quickstart" description: "Deploy your documentation site and make your first changes." --- -[Create an account](https://mintlify.com/start) and complete onboarding to get started. - -## Deploy your site - -After onboarding, your documentation site deploys automatically to: - -``` -https://.mintlify.app -``` - -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +[Create an account](https://mintlify.com/start) to get started. Your site deploys automatically after onboarding. ## Make your first edit -Choose your preferred workflow: - ### Web editor -1. Open the [Editor](https://dashboard.mintlify.com/editor) in your dashboard -2. Select `index.mdx` from the file explorer +1. Open the [Editor](https://dashboard.mintlify.com/editor) +2. Select `index.mdx` 3. Change the title to "Hello World" 4. Click **Publish** -Your changes deploy immediately. - ### Local development -Install the CLI: +Install the CLI and edit locally: ```bash npm @@ -42,30 +28,18 @@ Install the CLI: ``` -Edit your docs: - 1. Run `mint new` to create a project -2. Open `index.mdx` and change the title to "Hello World" +2. Edit `index.mdx` 3. Run `mint dev` to preview at `localhost:3000` -4. Push your changes to deploy - -## Add a custom domain - -Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) and add your domain (e.g., `docs.yourcompany.com`). - -Configure your DNS: - -| Record Type | Name | Value | TTL | -|-------------|------|-------|-----| -| CNAME | docs | cname.vercel-dns.com | 3600 | +4. Push to deploy ## Next steps - Customize your site with the `docs.json` file + Customize your site - Structure your documentation + Structure your docs Use interactive elements