typescript-eslint / typescript-eslint/ts-api-utils
📝 Documentation: Surface categories on the site in some way?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 122
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report Checklist
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the old README.md grouping of Comments, Compiler Options, and Flags with the TypeDoc-generated site's current sidebar. Start by locating the site's documentation navigation configuration, then determine how those categories could be represented; done means the documented items are easier to find through category-based navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100