Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added images/monorepo-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/monorepo-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 33 additions & 28 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,33 +24,39 @@ supercharge your documentation with Mintlify.

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.
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="github" title="Creating your documentation repository">

If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify [dashboard](https://dashboard.mintlify.com).

To create your docs repo without logging into GitHub, follow these instructions:
1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later.
2. [Get in touch](mailto:support@mintlify.com) with our team to deploy your repo.

<Frame>
![Starter Template](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/starter-template.png)
</Frame>

</Accordion>

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

The next step is to install our GitHub app. This ensures 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.

<Frame>
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
</Frame>
<Frame>
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
</Frame>

</Accordion>

<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
`mint.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>

</AccordionGroup>

### Updating the Content
Expand All @@ -65,7 +71,7 @@ your docs.
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>
Expand Down Expand Up @@ -120,7 +126,8 @@ 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).

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

</Accordion>
Expand Down Expand Up @@ -150,7 +157,7 @@ your docs.
<Accordion icon="chart-simple" title="Adding 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).

</Accordion>
Expand All @@ -165,13 +172,11 @@ your docs.

<Accordion icon="star" title="Adding a custom domain">

Integrate your docs into your website by hosting them on a custom domain. This is included even in the free plan.

Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.

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

<Frame>![Custom Domain](/images/custom-domain.png)</Frame>

</Accordion>

Expand Down
Loading