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
314 stars 75 forks source link

Update the 'does not contain nav' messaging to include 'docs_dir' option #63

Closed lewiseason closed 2 years ago

lewiseason commented 2 years ago

Thanks to waltermaldonado's excellent PR #35, it's possible for the plugin to use the implicit nav generation, just by specifying docs_dir in the included site's mkdocs.yml.

This change just makes that fact obvious in the error message.

I recently revisited this project, assumed you still had to explicitly define each site's nav, and was pleasantly surprised to find you didn't have to. I only discovered this by looking at the source code though!

Let me know if this requires an additional test, or if anybody has a more elegant way of wording the message :grimacing:

ottosichert commented 2 years ago

Thanks for adding this message to help all future contributors who might run into this issue!