pastelsky / tsdocs

Browse type documentation for JS libraries
https://tsdocs.dev
MIT License
1.12k stars 25 forks source link

Recommendations for priming cache on package release? #46

Open JoshuaKGoldberg opened 9 months ago

JoshuaKGoldberg commented 9 months ago

👋 I found this project recently and think it's awesome. Really nice way to solve the issue of TypeDoc-ing packages. Yay! Thanks for making it!

I separately filed #44 and #45 around improving the cold start experience for new packages. But even if those two get improved, it's likely that larger packages will inevitably take a while to build on each new version. Could tsdocs provide a recommendation around how packages should handle "priming" the cache on new package release?

For example, could a copy-and-paste script (or published GitHub Action) be added to the docs that pings https://tsdocs.dev/docs/<package-name> as a part of a release flow?