diff --git a/docs.json b/docs.json index caf2fd161..f96802008 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,10 @@ { "group": "Editing", "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] + "pages": [ + "development", + "web-editor" + ] }, "settings/global", { @@ -36,7 +39,8 @@ "navigation/localization" ] }, - "migration" + "migration", + "quickstart" ] }, { @@ -94,7 +98,10 @@ { "group": "Custom Scripts", "icon": "code", - "pages": ["advanced/custom/css", "advanced/custom/js"] + "pages": [ + "advanced/custom/css", + "advanced/custom/js" + ] }, { "group": "Custom Subdirectory", @@ -205,7 +212,7 @@ "pages": [ "integrations/analytics/overview", "integrations/analytics/amplitude", - "integrations/analytics/clearbit", + "integrations/analytics/clearbit", "integrations/analytics/fathom", "integrations/analytics/google-analytics", "integrations/analytics/google-tag-manager", @@ -251,7 +258,9 @@ "groups": [ { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ] } @@ -366,4 +375,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file diff --git a/quickstart.mdx b/quickstart.mdx index 76ec6868b..10f896463 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -17,20 +17,20 @@ icon: "rocket" ## Getting Started -Welcome! Follow the instructions below to learn how to deploy, update and +Welcome! Follow the instructions below to learn how to deploy, update, and supercharge your documentation with Mintlify. ### Creating the Repository 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. +your docs with your code and make source control effortless. Get started by onboarding through the [dashboard](https://dashboard.mintlify.com) or cloning our [starter kit](https://github.com/mintlify/starter). - 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. + 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. ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) @@ -39,10 +39,10 @@ your docs with your code, and make source control effortless. Onboard through th - 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 - `docs.json` in the - [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings) + If you want your docs to live alongside your code in a monorepo setup, you can: + 1. Move your docs content to your monorepo + 2. Specify the path to your `docs.json` in the [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings) + Monorepo setup - 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`. + 1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) + 2. Clone your docs repository using `git clone `. If you haven't set up Git yet, now would be a good time to do so with [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. Open the repository in your favorite IDE + 4. Install the Mintlify CLI to preview changes with `npm i -g mintlify` Learn more about this in our [local development guide](/development). @@ -78,13 +78,13 @@ your docs. - Learn more about how to use the web editor on our [guide](/web-editor). + Learn more about how to use the web editor in our [guide](/web-editor). - Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations: + Easily customize colors, logos, and buttons among other configurations in your `docs.json` file. Start with these basic configurations: ```json "name": "Your Company" @@ -101,13 +101,13 @@ your docs. }, ``` - A full list of supported configurations can be found at [global settings](/settings/global). + A full list of supported configurations can be found in our [global settings](/settings/global). - Add content with simple MDX files. Initiate your pages with this template: + Add content with simple MDX files. Start your pages with this template: ```md --- @@ -123,32 +123,31 @@ your docs. - 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). + 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 cannot successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com). - ![Manual - Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) + ![Manual Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) - You can easily set up your API references using an OpenAPI document. + 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 `docs.json` with a URL. + 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository, or define the `openapi` field in `docs.json` with a URL: ```json "openapi": "link-to-your-openapi-file" ``` - 2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as: + 2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files: ```bash npx @mintlify/scraping@latest openapi-file ``` - 3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`. + 3. Include the generated endpoint MDX files in your `docs.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). @@ -156,7 +155,7 @@ your docs. - 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). + 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). We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). @@ -165,14 +164,14 @@ your docs. 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). + Interested? You can [contact us](mailto:sales@mintlify.com). ### Publishing -Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan. +Integrate your docs into your website by hosting them on a custom domain. This feature is included in the free plan. Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. @@ -180,7 +179,6 @@ Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/setting -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). +Congratulations! You've set up your Mintlify docs, and they're looking amazing! Need +support or want to give feedback? Join our [community](https://mintlify.com/community) or email us at +[support@mintlify.com](mailto:support@mintlify.com). \ No newline at end of file