typescript-eslint / typescript-eslint/ts-api-utils
📝 Documentation: Consider using tsdocs.dev for deployed site instead of TypeDoc
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
I learned recently about tsdocs.dev: a really cool initiative to auto-create docs sites for npm packages. It does basically everything the deployed site does or wants to:
- TypeDoc generated docs (what tsdocs.dev is doing on the inside)
- ...with a nicer looking theme than ours IMO
- Search!
- Version selector
@RebeccaStevens what do you think about pointing users to that site instead of the generated TypeDoc one? That way we can remove all the TypeDoc scaffolding from the build system (🥲).
Additional Info
Issues this would let us close: #144, #150 (maybe), #260
Cold start performance on https://tsdocs.dev/docs/ts-api-utils isn't great. We'll probably want to contribute to the project in some way to help them out. Maybe we should ping the tsdocs.dev url whenever a new package version is released. And/or, I wonder if they're getting overwhelmed with traffic...? 😄
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
Start by reviewing the TypeDoc scaffolding in the build system and the currently deployed documentation site, then compare them with tsdocs.dev's TypeDoc, search, and version-selector capabilities. Done means reaching a maintainer decision on whether to redirect users, remove the existing scaffolding, and address the related issues identified in the proposal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100