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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Documentation: Consider using tsdocs.dev for deployed site instead of TypeDoc #387

Open
2 tasks done
JoshuaKGoldberg opened this issue Feb 5, 2024 · 1 comment
Open
2 tasks done
Labels
area: documentation Improvements or additions to docs 📝 status: in discussion Not yet ready for implementation or a pull request

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Feb 5, 2024

Bug Report Checklist

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...? 😄

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs 📝 status: in discussion Not yet ready for implementation or a pull request labels Feb 5, 2024
@RebeccaStevens
Copy link
Collaborator

From my understanding, tsdocs uses TypeDoc under the hood to generate the page.
So we'll want to keep all the things to do with ensuring we're documenting the code right, but the generation of our docs site can definitely be replaced.

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
Projects
None yet
Development

No branches or pull requests

2 participants