Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Documentation: Surface categories on the site in some way? #150

Open
2 tasks done
JoshuaKGoldberg opened this issue Mar 8, 2023 · 0 comments
Open
2 tasks done
Labels
area: documentation Improvements or additions to docs 馃摑 status: in discussion Not yet ready for implementation or a pull request type: feature New enhancement or request 馃殌

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

The old README.md grouped the documented things: Comments, Compiler Options, Flags, etc. The new TypeDoc-generated site doesn't group like that. The sidebar just sorts by type of thing: function, interface, type.

I'm finding it difficult to search through that very large sidebar to find the relevant things I need. Proposal: let's have that sidebar nest by the same categories as before?

Additional Info

cc @RebeccaStevens - what do you think?

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs 馃摑 type: feature New enhancement or request 馃殌 status: in discussion Not yet ready for implementation or a pull request labels Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs 馃摑 status: in discussion Not yet ready for implementation or a pull request type: feature New enhancement or request 馃殌
Projects
None yet
Development

No branches or pull requests

1 participant