Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 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.
39 changes: 33 additions & 6 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,27 +30,54 @@ your docs with your code, and make source control effortless.
<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).

<Note>
To create your docs repo without logging into Github, clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later.
![Starter Template](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/starter-template.png)
</Note>

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:[email protected]) with our team to deploy your repo.

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

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.

<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">

We support a monorepo setup, allowing you to add our starter template within a docs folder in your existing repo
1. Clone the starter template and move its contents into your docs folder
2. Delete the `.git` directory inside of the `docs` folder
3. You can also choose 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>
The mono-repo setup eliminates the need for creating a new repo.

</Accordion>

</AccordionGroup>

### Updating the Content
Expand Down
Loading