Create a new docs website

[millsp]

The current website is very old and generally is this project, since it hasn't been maintained for long. In order to have a fresh start, and before we start tackling the open issues, I think that having good documentation website is a must. I don't think Typedoc is a good fit anymore, as it has changed lots and my original theme is now broken.

I am planning to simply start with a docusaurus website, use typedoc to emit json and generate markdown pages. I know there is a markdown plugin that also works with docusaurus, but I am not satisfied with the experience that gives wrt to types.

[KubaJastrz]

You can take a look at TypeScript Website and twoslash markup format. They use it to create "more interactive" code examples with type checking enabled.

Typedoc is still being used for automatic generation, for example Remeda uses it like so:
https://github.com/remeda/remeda/blob/f750bd25397eec66b2652c77895ca5136b9739c1/package.json#L40
https://github.com/remeda/remeda/blob/f750bd25397eec66b2652c77895ca5136b9739c1/scripts/generate.ts

For the website and markdown part, there are many options tbh. Like Docusaurus, VuePress, or Astro Docs template.

[y471n]

I think we should have a proper cheat sheet or examples of each of the types utilities. That would be really helpful. I can start contributing to that. @millsp If you have any suggestions on where to kickstart this?

[Narretz]

Are you still working on the doc site or this project in general @millsp ?