Skip to content

Commit f320564

Browse files
committed
add monorepo guide
1 parent ec3670d commit f320564

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

guides/monorepo.mdx

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,39 @@
22
title: "Monorepo setup"
33
description: "Deploy your docs from a repo that contains multiple projects"
44
icon: "folder-git"
5-
---
5+
---
6+
7+
Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories that contain multiple projects or services.
8+
9+
## Prerequisites
10+
11+
* Admin or owner access to your Mintlify project.
12+
* Documentation files organized in a dedicated directory within your monorepo.
13+
* A valid `docs.json` in your documentation directory.
14+
15+
## Configure monorepo deployment
16+
17+
<Steps>
18+
<Step title="Access Git settings">
19+
Navigate to to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
20+
21+
<Frame>
22+
<img
23+
className="block dark:hidden my-0 pointer-events-none"
24+
src="/images/monorepo-light.png"
25+
alt="The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified."
26+
/>
27+
<img
28+
className="hidden dark:block my-0 pointer-events-none"
29+
src="/images/monorepo-dark.png"
30+
alt="The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified."
31+
/>
32+
</Frame>
33+
34+
</Step>
35+
<Step title="Set your documentation path">
36+
1. Select the **Set up as monorepo** toggle button.
37+
2. Enter the relative path to your docs directory.
38+
3. Select **Save changes**.
39+
</Step>
40+
</Steps>

0 commit comments

Comments
 (0)