From 7dfd41240539190d80dc3d59c6beec3f1228a9e0 Mon Sep 17 00:00:00 2001 From: mintlifydavid Date: Wed, 24 Sep 2025 16:35:10 -0700 Subject: [PATCH] Documentation edits made through Mintlify web editor --- quickstart.mdx | 129 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 98 insertions(+), 31 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..ce4328443 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -9,10 +9,14 @@ This quickstart guide shows you how to set up and deploy your documentation site 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**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. +this is just to show jack how this works - + + + ## Getting started @@ -25,8 +29,17 @@ https://.mintlify.app Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - Mintlify Domain - Mintlify Domain + 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. @@ -44,8 +57,17 @@ Install the GitHub App by following the instructions from the onboarding checkli 5. Select the repositories that you want to connect. - GitHub App Installation - GitHub App Installation + GitHub App Installation + + GitHub App Installation @@ -83,13 +105,16 @@ The code-based workflow integrates with your existing development environment an 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: - ```bash npm - npm i -g mint - ``` - ```bash pnpm - pnpm add -g mint - ``` +```bash npm +npm i -g mint +``` + + +```bash pnpm +pnpm add -g mint +``` + @@ -130,8 +155,17 @@ mint dev Your preview will be available at `localhost:3000`. - Mintlify Dev - Mintlify Dev + Mintlify Dev + + Mintlify Dev ### Push the changes @@ -142,7 +176,7 @@ Mintlify automatically detects the changes, builds your documentation, and deplo 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. @@ -160,8 +194,17 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf - The Mintlify web editor in the visual editor mode - The Mintlify web editor in the visual editor mode + The Mintlify web editor in the visual editor mode + + The Mintlify web editor in the visual editor mode ### Edit the documentation @@ -173,12 +216,23 @@ 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 + 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. + 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 @@ -198,16 +252,25 @@ While your `.mintlify.app` subdomain works well for testing a 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 + 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.mintlify.app | 3600 | + | Record Type | Name | Value | TTL | + | ----------- | ------------------- | ------------------ | ---- | + | CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
@@ -218,19 +281,23 @@ Enter your domain (for example, `docs.yourcompany.com`) and follow the provided 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. - + + Structure your documentation with intuitive navigation to help users find what they need. - + + Enhance your documentation with interactive components like accordions, tabs, and code samples. - + + Create interactive API references with OpenAPI and AsyncAPI specifications. @@ -248,4 +315,4 @@ If you encounter issues during the setup process, check these common troubleshoo 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. - + \ No newline at end of file