starlight-typedoc icon indicating copy to clipboard operation
starlight-typedoc copied to clipboard

Can't get groups/categories to work

Open Klaasvaak opened this issue 4 months ago • 1 comments

Describe the bug

When adding @category components to my react components docs I was expecting to have a new menu item to show up named components. This is not the case. Am I missing any config or is this not supported?

To Reproduce

Add @category components to your docs. I think @group components should be the same

Expected behavior

After a build I would expect components to show up in the side menu

How often does this bug happen?

Every time

System Info

No response

Additional Context

No response

Klaasvaak avatar Jul 22 '25 07:07 Klaasvaak

Thanks for the feedback :raised_hands:

This is indeed not supported at the moment as the plugin relies on Starlight's autogenerated group feature to create the sidebar structure. As a group created with the @group directive, e.g. @group components will not have a corresponding file on disk in a components/ directory, they are not included in the sidebar structure.

Depending on the expected behavior, I think this may be possible to implement. When tagging something with @group, would you expect the associated sidebar entry to be moved to a new group with a label matching the @group directive? Or would you expect the sidebar entry to remain in its current group but duplicated under the new group?

Of course, this would still require some investatigation to confirm if this is feasible, as I assume depending on the expected behavior, this would still be a non-trivial change to the plugin.

HiDeoo avatar Jul 26 '25 17:07 HiDeoo