Overhauled Documentation

[jasonkuhrt]

Today I overhauled the documentation. All examples are now strictly as source code in TypeScript modules. This way errors are caught and, linter runs over them too, etc.

Why the normalization? Because it was not maintainable as it was, evidenced by e.g.:

• many instances where the README example had deviated from the source code one (e.g. mix of ESM vs CJS).
• examples in the README that did not have source code analogs and vice versa (examples in source code not shown in the README).
• many instances of outright bugs (reference errors, type errors, etc.)
• many instances of non-runnable examples

I have grouped all the examples into general buckets like "configuration" and "community".

I clarified/corrected our Nodejs version support policy.

I started a tiny section for reference docs, but there is not much there right now.

Converting some examples to source code files revealed a few paper cuts with regards to type references that I want to fix soon. Quick wins like a type export for response middleware.

I also want to make sure that all examples are runnable and then put that into CI to ensure that:

1. More confidence that ongoing work does not regress the library.
2. Confidence that the examples work.

I live in Montreal and it is 23 C ☀️ outside today which is great after a winter of temperatures like -23 C 😄. I was hoping to deliver more today but alas my mental health* beckons me outside ☺️.

Cheers!

(*) Related to this: I recently decided to pull out the upload functionality as I try to bring quality back to this library. I need a smaller surface area to work with.