Generated docs ordering by jsdocs
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
Instead of hard coding orderings of symbols in our API generator, we can use jsdocs to add a priority to the order of generated symbols.
Proposal, something like `@priority `.
Then when symbols on a page are sorted for order, they can optionally look at this jsdoc comment.
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
No files or tests are named. Start by locating the API generator and the code that sorts symbols or contains hard-coded orderings. Define how an optional @priority number should affect generated symbol order, then verify the resulting documentation output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100