Reference docs generation and plan.

[mixmix]

mega PR for us to jam on till it's done (as discussed with Frankie)

The aim of this PR is to :

• makes README.md a chill into + link out to further resources
• build docs/ into a rich website

What the website will look like:

[frankiebee]

This was a notes bucket... @mixmix anything worth keeping cc @frankiebee

[mixmix]

Here's what it looks like now with current config

[mixmix]

@frankiebee / @rh0delta this is ready for a review. I through out a lot of stuff and have just kept the "docs building" piece which makes HTML site which @johnnymatthews will presumably integrate at some place??

One thing we need to decide is what we want that site to look like. Currently that ugly HTML page has an ... on site map nested thing on the left but it's ... awkwardly named. Like it doesn't line up with what we export from the package.json :vomiting_face: So ... do we care/ wanna fix it? I've looked into typedoc config and can't find a nicer way of renaming those other than "move all the files" ... I think we might need to discuss "design" around what we export and why?

[johnnymatthews]

Ideally, if there's a way to spit out this stuff into regular old markdown files, then we can port it over to the main docs repo. Is that even a thing we can do?

[mixmix]

Decision: we need to have a documentation meeting @johnnymatthews can you come up with a proposal about how we're doing docs this / next week?

[mixmix]

@frankiebee please review

[johnnymatthews]

Created a relevant issue for planning over in Docs: https://github.com/entropyxyz/entropy-docs/issues/121

[mixmix]

@johnnymatthews can we merge this?

[mixmix]

Found a plugin which makes the entry points (sections on left) less of a mess

Also started adding some @examples to make it a lot clearer how to import / use some of these pieces

[mixmix]

Hey I want this PR merged or closed this week. @johnnymatthews I propose we merge as is, and set up Github generation of static site. We can change it later if we want