📝 Documentation: Consider using tsdocs.dev for deployed site instead of TypeDoc #387
Open
2 tasks done
Labels
area: documentation
Improvements or additions to docs 📝
status: in discussion
Not yet ready for implementation or a pull request
Bug Report Checklist
main
branch of the repository.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:
@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...? 😄
The text was updated successfully, but these errors were encountered: