From 07ce89ce3c53e031b0d403522cc691bf969e65a6 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 16:31:40 +0000 Subject: [PATCH 1/2] Documentation edits made through Mintlify web editor --- quickstart.mdx | 80 ++++++++++++++++---------------------------------- 1 file changed, 26 insertions(+), 54 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 76ec6868b..1ddf6c9a4 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -5,14 +5,9 @@ icon: "rocket" --- - - + + + ## Getting Started @@ -27,36 +22,26 @@ Mintlify docs are rendered from MDX files and configurations defined in our 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. - ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) + ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) - - - 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) - - Monorepo setup - Monorepo setup - - + + 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) + + Monorepo setup + + Monorepo setup + + ### Updating the Content @@ -66,24 +51,22 @@ 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 `docs.json` file. Start with these basic configurations: ```json @@ -102,11 +85,9 @@ your docs. ``` 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: ```md @@ -118,22 +99,18 @@ your docs. ``` 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). - - ![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. 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL. @@ -151,15 +128,12 @@ your docs. 3. Finally, include the generated endpoint MDX files to 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). - - 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). - @@ -171,16 +145,14 @@ your docs. ### 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 is included in the free plan. - -Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. - -![Custom Domain](/images/custom-domain.png) + Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. + ![Custom Domain](/images/custom-domain.png) 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). +[support@mintlify.com](mailto:support@mintlify.com). \ No newline at end of file From fc5b69a3a6d1acf525ae66457024a14d11eb599b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 16:32:08 +0000 Subject: [PATCH 2/2] Documentation edits made through Mintlify web editor --- quickstart.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/quickstart.mdx b/quickstart.mdx index 1ddf6c9a4..17dc7257a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -10,6 +10,8 @@ icon: "rocket" +this is a test + ## Getting Started Welcome! Follow the instructions below to learn how to deploy, update and