Skip to content

Note to not use trailing slash in monorepo setup #794

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.

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 1 commit into from
Jun 6, 2025
Merged
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
5 changes: 4 additions & 1 deletion guides/monorepo.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "Monorepo setup"

Check warning on line 2 in guides/monorepo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/monorepo.mdx#L2

Did you really mean 'Monorepo'?
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.

Check warning on line 7 in guides/monorepo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/monorepo.mdx#L7

Did you really mean 'monorepo'?

## Prerequisites

* Admin access to your Mintlify project.
* Documentation files organized in a dedicated directory within your monorepo.

Check warning on line 12 in guides/monorepo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/monorepo.mdx#L12

Did you really mean 'monorepo'?
* A valid `docs.json` in your documentation directory.

## Configure monorepo deployment

Check warning on line 15 in guides/monorepo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/monorepo.mdx#L15

Did you really mean 'monorepo'?

<Steps>
<Step title="Access Git settings">
Expand All @@ -34,7 +34,10 @@
</Step>
<Step title="Set your documentation path">
1. Select the **Set up as monorepo** toggle button.
2. Enter the relative path to your docs directory.
2. Enter the relative path to your docs directory. For example, if your docs are in the `docs` directory, enter `/docs`.
<Note>
Do not include a trailing slash in the path.
</Note>
3. Select **Save changes**.
</Step>
</Steps>