Description
Description
When I search for "NavItem" or "NavGroup" in the SaasUI docs site, I expect to find it in the results. Instead, I have to infer from the sample app that, since the NavItem is used within the Sidebar, I should go look there for its docs, even though its component name wouldn't imply that's the place to look.
Related: I'd expect the structure of Storybook to similarly make it clear how to find docs on such a component. Instead, the 'NavItem' and 'NavGroup' are under a heading called 'Navigation' which has a heading in the docs... but these components aren't there.
Link to Reproduction
https://saas-ui.dev/docs/components/layout/sidebar
Steps to reproduce
- Go to the Docs site
- Find a component which contains subcomponents shown on its 'Usage' tab, but which are not shown in the left sidebar
- Search for that subcomponent name using the "Search Docs" feature
- Get no results, even though you're looking right at it on the page of its parent component
Saas UI Version
2.8.7
Chakra UI Version
2.8.2
Browser
All
Operating System
- macOS
- Windows
- Linux
Additional Information
If nothing else, it would help to change the name of all sub-components so that they're at least namespaced to the parent component where I can find the docs. For instance: Sidebar-NavItem
instead of NavItem
tells me where to look for docs. That would at least solve 80% of the problem, if there's a logical way to do that, and if some of the problem components don't belong to multiple parents. (But... that's a workaround. They should still show up in search.)
(P.S. I'm a paid user of SaasUI-pro for a prototype. I love where it's headed in many ways, but spending 10 minutes scratching my head looking for docs on a basic component makes me loath to scale it across my company. I know you might be focused on other key features, but for an enterprise product, complete docs are a key feature.)