Skip to content

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

Open
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: documentationImprovements or additions to docs 📝status: in discussionNot yet ready for implementation or a pull request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions