Docs overhaul

[krzkaczor]

TODO:

• [x] upgrade docozaurus
• [ ] add searchbox
• [ ] add example to the main page: Releated: https://github.com/dethcrypto/earl/issues/142
• [ ] add somewhere link to the changelog
• [ ] update CONTRIBUTING.md
• [ ] add playground

[hasparus]

add searchbox

https://docusaurus.io/docs/search#using-algolia-docsearch

Shall we apply for Algolia DocSearch? (It went pretty smoothly for Theme UI and the search experience is top notch.)

[krzkaczor]

Shall we apply for Algolia DocSearch? (It went pretty smoothly for Theme UI and the search experience is top notch.)

Yes, that was my idea. The problem is that our docosaurus instance is unupgradable at the moment because I modified it to look better 😅 I hate the original look and I tweaked some elements so it looks more like gitbook. It would be great to redo it as some kind of theme...

[hasparus]

Oh we could use DocSearch even without Docusaurus, so these two don't conflict. I just linked the docusaurus docs as I had them already open.

I like Supabase's approach

• They have a nice introduction page as docusaurus home page: https://supabase.com/docs
• and a custom landing page with all the cool stuff to sell the idea: https://supabase.com/

as we probably have a lower budget, the landing page could be a list of features and a few code snippets, but it would be enough.

[krzkaczor]

More ideas:

• real-world usage guide,
• more examples,
• grammar check,

[sz-piotr]

Closing as sub issues were created