diff --git a/quickstart.mdx b/quickstart.mdx
index 076b50534..2f21c8d80 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -4,19 +4,15 @@ 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
+## 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
@@ -29,39 +25,18 @@ Find your URL on the Overview page of your [dashboard](https://dashboard.mintlif
-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.
+## GitHub setup
-Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
+Connect your GitHub repository to enable automatic deployments:
-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**
-
- 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:
@@ -76,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
@@ -92,160 +67,86 @@ 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
-
-After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
+### Edit and preview
-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
-### 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.
+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.
-
+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
- 
- 
-
-
-### 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".
-
-
- 
- 
+
+
- 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 access formatting tools and components. Use branches for collaborative editing and pull request workflows.
-### 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.
+## Custom domain (optional)
-
- Use branches to preview and review changes through pull requests before deploying to your live site.
-
+Add a custom domain for production use:
-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.
-
-To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
-
-
- 
- 
-
-
-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.
-
+
+
+
+
## 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
-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.