search

backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
316 stars 74 forks source link

Question on limitations - nested documentation projects #17

Open dellagustin-sap opened 4 years ago

dellagustin-sap commented 4 years ago

Hello,

The documentation on Limitations states that "In an included mkdocs.yml, you cannot have !include. It is only supported in the root mkdocs.yml".

I would like to know if this is a design decision or a limitation that could be addressed in the future?

bih commented 4 years ago

@dellagustin-sap Hello! It is only a design decision. In the initial version, this was working and there wasn't an issue but after using it for a while we realized it added a ton of complexity when trying to traverse the documentation. At Spotify at least we haven't had the need to have "nested" documentation inside of a "nested" mkdocs.yml.

I would ask you: do you really need this? When we asked ourselves this, it was a no :)

bih commented 4 years ago

I'll mark it as wontfix for now, but will leave the issue open in case there's some perspective you have that'll change the decision :)

dellagustin-sap commented 4 years ago

Hi, thank you for your quick reply, I'll try to add some thoughts in the near future.