API documentation pages

[stazz]

Since all of the public types and functions already have JSDoc comments on them, there should be some kind of API doc pages generated out of them. The benefit is that users are able to browse the TyRAS API documentation without needing to locally install the packages and explore via intellisense.

[stazz]

Preliminary idea of the approach:

• Add @category to all exported elements of all packages of TyRAS, one of
  • protocol,
  • server, or
  • client.
• Use typedoc with typedoc-plugin-markdown to produce .md files containing the same content as JSDoc in the code. Use --excludeCategories flag to produce one .md file per category.
• Either
  • Use Github Pages from the resulting .md files directly, or
  • Use Docusaurus to transform .md pages into static files and host these Somewhere^TM (here is some info about additional tweaks and such to do when using this option)

[stazz]

Idea of variants (url routes):

• By data validation framework:
  • io-ts
  • runtypes
  • zod
• By internal packages

Each variant would have a version selector as well, which would be url route too. Final URL would be something like: /<data validation framework>/<version number or 'latest'> or /packages/<package name>/<version number or 'latest'>. Categories would not show up in URL.