You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For a multi-product website, how should we go about creating a single documentation website for all products and make search work?
Right now search shows results for all products no matter where you are in the documentation. This has a side-effect that if you search for "Getting", it shows "Getting Started" in all products without context.
Here's the structure we used:
pages
_meta.json
index.mdx
product-1 (folder)
_meta.json
getting-started.mdx
:
:
product-2 (folder)
_meta.json
getting-started.mdx
:
:
product-3 (folder)
_meta.json
getting-started.mdx
:
:
The index.mdx is a landing page with sections for each product (like docs.github.com). It has no sidebar or toc.
The user can click on "Getting Started" under "Product 1" to go to product-1/getting-started.mdx. This page now has a sidebar with docs for everything under "product-1". However, if you search, it displays results across entire system without context having the above mentioned side-effect.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
For a multi-product website, how should we go about creating a single documentation website for all products and make search work?
Right now search shows results for all products no matter where you are in the documentation. This has a side-effect that if you search for "Getting", it shows "Getting Started" in all products without context.
Here's the structure we used:
The index.mdx is a landing page with sections for each product (like docs.github.com). It has no sidebar or toc.
The user can click on "Getting Started" under "Product 1" to go to product-1/getting-started.mdx. This page now has a sidebar with docs for everything under "product-1". However, if you search, it displays results across entire system without context having the above mentioned side-effect.
Thanks!
Beta Was this translation helpful? Give feedback.
All reactions