diff --git a/docs.json b/docs.json index ef20fc512..2de58342d 100644 --- a/docs.json +++ b/docs.json @@ -134,6 +134,7 @@ "guides/migration", "mcp", "translations", + "guides/monorepo", "react-components", "settings/custom-scripts", "settings/seo", diff --git a/guides/monorepo.mdx b/guides/monorepo.mdx new file mode 100644 index 000000000..c6b5f64db --- /dev/null +++ b/guides/monorepo.mdx @@ -0,0 +1,40 @@ +--- +title: "Monorepo setup" +description: "Deploy your docs from a repo that contains multiple projects" +icon: "folder-git" +--- + +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. + +## Prerequisites + +* Admin access to your Mintlify project. +* Documentation files organized in a dedicated directory within your monorepo. +* A valid `docs.json` in your documentation directory. + +## Configure monorepo deployment + + + +Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. + + +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. +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. + + + + +1. Select the **Set up as monorepo** toggle button. +2. Enter the relative path to your docs directory. +3. Select **Save changes**. + +