Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.

Monorepo documentation issues with navigation #214

Open
mrlubos opened this issue Jul 19, 2021 · 1 comment
Open

Monorepo documentation issues with navigation #214

mrlubos opened this issue Jul 19, 2021 · 1 comment

Comments

@mrlubos
Copy link

mrlubos commented Jul 19, 2021

Hey there! I was wondering what's the best approach for documenting a monorepo? The approach I took is having a single docs folder contain all files. This works, but I am running into some issues with dynamic links. Assume I have 2 projects I want to document and they would live at domain.com/docs/foo and domain.com/docs/bar. I am able to create a proper structure inside my monorepo by having a parent content folder and inside it 2 folders for bar and foo. Rendering these pages will work, but the left navigation doesn't change. Also, in the footer for each page, there are dynamic links to the next page, but these break if I go inside any folder. Can anybody advise how to approach this? Thanks!

@mrlubos
Copy link
Author

mrlubos commented Jul 19, 2021

If this is something that is currently not supported, I wonder if it's under development or could be easily added? cc @trevorblades @StephenBarlow

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant