From 9e5e31646ae8e722cf019835906702851afa99b7 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 15 Jan 2025 03:35:33 +0000
Subject: [PATCH] Documentation edits made through Mintlify web editor
---
quickstart.mdx | 234 +++++++++++++++++++------------------------------
1 file changed, 89 insertions(+), 145 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index fd4ba0858..5fe3f23f9 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -15,172 +15,116 @@ icon: "rocket"
/>
-## Getting Started
+Welcome to Mintlify! This guide will help you set up your documentation in just a few minutes.
-Welcome! Follow the instructions below to learn how to deploy, update and
-supercharge your documentation with Mintlify.
+
+
+ Get started with Mintlify by either:
+ - Creating a new project through our [dashboard](https://dashboard.mintlify.com)
+ - Cloning our [starter template](https://github.com/mintlify/starter)
-### Creating the Repository
+
+ Install our GitHub app from the [dashboard settings](https://dashboard.mintlify.com/settings)
+ to enable automatic deployments when you push changes.
+
+
-Mintlify docs are rendered from MDX files and configurations defined in our
-[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
-your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.
-
-
-
-
-
- Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
-
-
- 
-
-
-
-
-
- If you want your docs to live alongside your code as a monorepo setup, you
- can: 1. Move your docs content to your monorepo. 2. Specify the path to your
- `mint.json` in the
- [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
-
- 
- 
-
-
-
-
-
-### Updating the Content
-
-Mintlify enables you to easily customize the style, structure, and content of
-your docs.
-
-
-
-
- 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
- 2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
- 3. Use your favorite IDE to open the repository.
- 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
-
- Learn more about this in our [local development guide](/development).
-
-
-
-
-
- Learn more about how to use the web editor on our [guide](/web-editor).
-
-
-
-
-
- Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
-
- ```json
- "name": "Your Company"
- "logo": {
- "light": "/logo/light.svg",
- "dark": "/logo/dark.svg",
- "href": "https://yourcompany.com"
- },
- "favicon": "/favicon.svg",
- "colors": {
- "primary": "#2AB673",
- "light": "#55D799",
- "dark": "#117866",
- },
- ```
-
- A full list of supported configurations can be found at [global settings](/settings/global).
-
-
-
-
-
- Add content with simple MDX files. Initiate your pages with this template:
+
+ Create new MDX files in your docs folder using this basic template:
```md
---
title: "Page Title"
- sidebarTitle: "Sidebar title (optional - if different from page title)"
- description: "Subtitle (optional)"
+ description: "A description of the page"
---
- ```
- Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
-
-
-
-
-
- Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
-
-
- 
-
-
-
-
-
-
- You can easily set up your API references using an OpenAPI document.
-
- 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
-
- ```json
- "openapi": "link-to-your-openapi-file"
+ Your content here
```
- 2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
+ Add the page to your navigation in `mint.json`:
- ```bash
- npx @mintlify/scraping@latest openapi-file
+ ```json
+ {
+ "navigation": [
+ {
+ "group": "Getting Started",
+ "pages": ["quickstart"]
+ }
+ ]
+ }
```
- 3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
-
- For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
-
-
-
-
-
- Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
+ Learn more about [writing MDX](/text) and using our [components](/content/components).
+
- We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
+
+ Customize your documentation's appearance in `mint.json`:
-
-
+ ```json
+ {
+ "name": "Your Company",
+ "logo": {
+ "light": "/logo/light.svg",
+ "dark": "/logo/dark.svg"
+ },
+ "favicon": "/favicon.svg",
+ "colors": {
+ "primary": "#2AB673",
+ "light": "#55D799",
+ "dark": "#117866"
+ }
+ }
+ ```
-
- We provide a white-glove migration service as part of our Enterprise plan.
- Interested? You can request it by [contacting us](mailto:sales@mintlify.com).
-
+ Get the full list of options in our [global settings](/settings/global).
+
-### Publishing
+
+ You have two options to preview your changes:
-
+ **Option 1: Local Development**
+ ```bash
+ # Install the Mintlify CLI
+ npm i -g mintlify
-Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
+ # Start local development
+ mintlify dev
+ ```
-Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
+ **Option 2: Web Editor**
+ Use our browser-based editor at your [dashboard](https://dashboard.mintlify.com). Learn more about the [web editor](/web-editor).
+
-
+
+ Once ready, commit and push your changes to deploy your documentation site:
-
+ ```bash
+ git add .
+ git commit -m "docs: update documentation"
+ git push
+ ```
-Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
-support or want to give some feedback? You can join our
-[community](https://mintlify.com/community) or drop us an email at
-[support@mintlify.com](mailto:support@mintlify.com).
+ Add a custom domain through the [dashboard settings](https://dashboard.mintlify.com/settings) to make your docs accessible at your own domain.
+
+
+
+## Next Steps
+
+Here are some helpful resources to enhance your documentation:
+
+
+
+ Learn how to document your API endpoints with OpenAPI
+
+
+ Set up analytics to track documentation usage
+
+
+ Customize the appearance of your documentation
+
+
+ Join our community to get help and share feedback
+
+
+
+Need expert help? We provide white-glove migration services with our Enterprise plan. [Contact us](mailto:sales@mintlify.com) to learn more.
\ No newline at end of file