From b92591bf7392559cbe5e48cb97079c05bbce6089 Mon Sep 17 00:00:00 2001 From: Reed Barnes Date: Tue, 17 Feb 2026 18:08:13 -0800 Subject: [PATCH] Refine quickstart guide introduction and accordion title order --- docs/quickstart.mdx | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 1334e77..7e23f2f 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -10,17 +10,17 @@ es_link: "https://developers.example.es/docs/quickstart" ## Get started in three steps -Get your documentation site running locally to make your changes. The best way to do this is following each step in order; laying a good foundation here will pay dividends. Make sure you have a good understanding of the steps before you move on to the next one. +Get your documentation site running locally to make your changes. The best way to do this is following each step in order; laying a really good foundation here will pay dividends. Make sure you have a good understanding of the steps before you move on to the next one. ### Step 1: Set up your local environment - + During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs. - + 1. Install the Mintlify CLI: `npm i -g mint` 2. Navigate to your docs directory and run: `mint dev` 3. Open `http://localhost:3000` to see your docs live! @@ -34,12 +34,12 @@ Get your documentation site running locally to make your changes. The best way t ### Step 2: Deploy your changes - + Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. - + For a first change, let's update the name and colors of your docs site. 1. Open `docs.json` in your editor. @@ -55,7 +55,7 @@ Get your documentation site running locally to make your changes. The best way t ### Step 3: Go live - + 1. Commit and push your changes. 2. Your docs will update and be live in moments! @@ -75,28 +75,28 @@ Now that you have your docs running, explore these key features: **Example XML feed**: - Download feed.xml +Download feed.xml to see how static XML files are served. - + Learn MDX syntax and start writing your documentation. - + Make your docs match your brand perfectly. - + Include syntax-highlighted code blocks. - + Auto-generate API docs from OpenAPI specs. - + View the Get Plants endpoint documentation. - + View the User API documentation. @@ -104,25 +104,25 @@ Now that you have your docs running, explore these key features: ## Essential features - + - Create and organize MDX files - Use frontmatter for metadata - Add images and assets - Structure with headings and sections - + - Configure site colors and branding - Customize navigation structure - Add custom CSS and components - Set up search functionality - + - Hot reload preview server - Automatic deployments via GitHub - Version control integration - CLI commands for common tasks - + - Syntax-highlighted code blocks - Interactive API documentation - Search and navigation @@ -133,19 +133,19 @@ Now that you have your docs running, explore these key features: ## Quick tips - + - Install Mintlify CLI globally - Clone your repository locally - Run `mint dev` to preview - Make changes and see updates instantly - + - Keep content organized in folders - Use descriptive file names - Write clear, concise documentation - Test your changes locally first - + - Check your `docs.json` configuration - Verify file paths and links - Review console for errors