Improve library API documentation

I’m not really happy with the TypeDoc-generated docs that are hosted at https://api-docs.simplewebauthn.dev/. It’s primarily because of things like this:

What arguments are within Options? Who knows?!

This is partially my fault for rolling with an old version of TypeDoc that works with a plugin that supports a “library” mode. I chose this approach because early testing produced adequate documentation of the monorepo’s multiple libraries, but it just hasn’t scaled well as the libraries’ have evolved.

Now that I have a proper website up with its own docs section, though, it’s feasible for me to start maintaining manually-authored API docs and host them there to achieve the desired level of exposure of the various methods’ arguments.

[MasterKale]

Whoops, didn’t mean for this to get closed (so that’s what happens when you link an issue to a PR 🤔). PR #66 upgraded docs to a beta release of TypeDoc that uses its upcoming Library mode and some of the roughness that inspired this ticket has already gone away.

That said I’m reopening this ticket to continue tracking improvements. I’m still not entirely satisfied, but maybe with some luck I can help the TypeDoc project improve its library mode.

[MasterKale]

Oh dang, Nuxt has a way for me to quickly get a site like that up and running? I went with Docusaurus because I thought I’d have to wire up my own version of Nuxt’s site and opted for something that seemed more turnkey.

I honestly prefer Nuxt’s format, though, so I’ll take a closer look at the template you linked.