Workaround Limitations

Documentation says "site_name must adhere follow the regular expression: ^[a-zA-Z0-9_\-/]+$"

My problem with that is that if you also want to single-build the repos you end up with a ugly site_name in the frontend. I wonder if you can introduce a new property like submodule_alias to work around that issue.

You may also autogenerate the machine name (lowercase, replace spaces and strip out special chars) and allow override via custom property. It would improve the "works out of the box" experience and you don't squat site_name prop.

https://github.com/spotify/mkdocs-monorepo-plugin/blob/a252e28a7129010e5e1db05efa08bade3ebb722c/mkdocs_monorepo_plugin/parser.py#L150

https://spotify.github.io/mkdocs-monorepo-plugin/limitations/

Start with parser.py around line 150 and the linked limitations page to understand how site_name is currently constrained and used. The proposal offers two possible directions, so first establish whether the desired behavior is submodule_alias or generated machine names with an override. Done should be an agreed, documented behavior that supports both single-build and repository builds.

Written by the indexing model from the issue text.