Skip to content

Bug: editor does not support having docs in subfolders as part of a mono-repo setup #4889

@Blargian

Description

@Blargian

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

Image

(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:

Image

Steps to reproduce

  • Enable monorepo setup in the Mintlify dashboard
  • Add a docs.json file under /docs folder 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions