Skip to content

Clarrify community != support #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 9, 2025
Merged

Clarrify community != support #621

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c83e6cf
Documentation edits made through Mintlify web editor
dino475 Apr 9, 2025
03b6171
Update quickstart.mdx
tiffany-mintlify Apr 9, 2025
852ffc5
Update quickstart.mdx
tiffany-mintlify Apr 9, 2025
33bf3dd
Update quickstart.mdx
tiffany-mintlify Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 46 additions & 67 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ icon: "rocket"
className="block dark:hidden"
src="https://mintlify-assets.b-cdn.net/hero-light.png"
/>

<img
className="hidden dark:block"
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
Expand All @@ -17,7 +18,7 @@ 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
Expand All @@ -27,36 +28,33 @@ 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.

<AccordionGroup>

<Accordion icon="message-bot" title="Install the GitHub app">

<Accordion title="Install the GitHub app" icon="message-bot">
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.

<Frame>
![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)
</Frame>

</Accordion>
<Accordion title="Monorepo Setup" icon="code-branch">
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)

<Accordion icon="code-branch" title="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)
<Frame>
<img
alt="Monorepo setup"
className="block dark:hidden"
src="/images/monorepo-light.png"
/>
<img
alt="Monorepo setup"
className="hidden dark:block"
src="/images/monorepo-dark.png"
/>
</Frame>
</Accordion>

<Frame>
<img
alt="Monorepo setup"
className="block dark:hidden"
src="/images/monorepo-light.png"
/>

<img
alt="Monorepo setup"
className="hidden dark:block"
src="/images/monorepo-dark.png"
/>
</Frame>
</Accordion>
</AccordionGroup>

### Updating the Content
Expand All @@ -65,25 +63,18 @@ Mintlify enables you to easily customize the style, structure, and content of
your docs.

<AccordionGroup>
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">

<Accordion title="Editing locally (recommended for developers)" icon="rectangle-terminal">
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 <your-repo>`. 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).

</Accordion>

<Accordion icon="pen-to-square" title="Editing with the web editor">

<Accordion title="Editing with the web editor" icon="pen-to-square">
Learn more about how to use the web editor on our [guide](/web-editor).

</Accordion>

<Accordion icon="palette" title="Customizing to your brand">

<Accordion title="Customizing to your brand" icon="palette">
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:

```json
Expand All @@ -102,11 +93,8 @@ your docs.
```

A full list of supported configurations can be found at [global settings](/settings/global).

</Accordion>

<Accordion icon="pencil" title="Adding content">

<Accordion title="Adding content" icon="pencil">
Add content with simple MDX files. Initiate your pages with this template:

```md
Expand All @@ -118,22 +106,16 @@ 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).

</Accordion>

<Accordion icon="rocket" title="Pushing changes">

<Accordion title="Pushing changes" icon="rocket">
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).

<Frame>
![Manual
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
</Frame>

<Frame>
![Manual
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
</Frame>
</Accordion>

<Accordion icon="code-branch" title="Generating API references">

<Accordion title="Generating API references" icon="code-branch">
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.
Expand All @@ -142,24 +124,20 @@ your docs.
"openapi": "link-to-your-openapi-file"
```

2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
1. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:

```bash
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
```

3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
1. 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).

</Accordion>

<Accordion icon="chart-simple" title="Adding analytics">

<Accordion title="Adding analytics" icon="chart-simple">
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).

</Accordion>
</AccordionGroup>

Expand All @@ -170,17 +148,18 @@ your docs.

### Publishing

<Accordion icon="star" title="Adding a custom domain">
<Accordion title="Adding a custom domain" icon="star">
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://dashboard.mintlify.com/settings) to add a custom domain.

Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
<Frame>
![Custom Domain](/images/custom-domain.png)
</Frame>
</Accordion>

<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
Congrats\! You've set up your Mintlify Docs and they're on the way to looking amazing\!

</Accordion>
Need support or want to give some feedback? You can click `support` in the [dashboard](http://dashboard.mintlify.com) (bottom left corner) or reach out to [[email protected]](mailto:[email protected]).

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
[[email protected]](mailto:[email protected]).
You can also join our [community](https://mintlify.com/community) to engage with other Mintlify users and stay up to date with the latest feature drops.