-
Notifications
You must be signed in to change notification settings - Fork 225
Bug: editor does not support having docs in subfolders as part of a mono-repo setup #4889
Description
Bug description
With a mono-repo setup, a user may wish to store their docs inside of a subfolder of the /docs folder. For instance when /docs exists within a larger codebase, but the user still wants to group all markdown files within a single folder rather than alongside docs.json.
For example:
/docs
|__ /docs.json
|__ /docs
|__ /products/*.mdx
|__ /integrations/*.mdx
|__ /reference/*.mdx
|__ /i18n
|__ /scripts
|__ /images
|__ /assets
The editor however appears to expects markdown files to be relative to /docs. In the editor this shows up as:
A) an error when clicking one of the pages from the "Navigation tab":
(With reference to the error in the image above, this is because the file exists not at /docs but /docs/docs/)
B) As an empty list when viewing from the "folders" tab:
Steps to reproduce
- Enable monorepo setup in the Mintlify dashboard
- Add a
docs.jsonfile under/docsfolder of the repo root - Add a new folder
/docs/docs/with some markdown files inside of it - Define your navigation to point to the files under
/docs/docs/ - Open the editor to observe behavior above
Expected behavior
It feels reasonable as a user to assume that the editor will be able to resolve the file locations where-ever they are, as long as they are somewhere under the /docs folder relative to the root of the repo.
Currently the work around for this is to move everything up one level from /docs/docs which is less clean.