Need a simple and accessible documentation site about electrodb HOT 4 CLOSED

Last night I merged initial pass of a docs site which is currently deployed to https://electrodb.dev. I still have a few more passes before I want to "announce" this (or closes this ticket), but rest assured this is happening 👍

from electrodb.

@anselm94 Thank you for taking the time to write out this feedback! I'd love to expand the documentation and see something just like this as well. I love the rough structure you laid out and over the next few months I hope to chip away at something like this 👍 Do you find any of the examples (Docusaurus, Vuepress, Mkdocs) you provided to be better than the others?

from electrodb.

I found Mkdocs Material to be powerful and very easy to work with.

In terms of examples, I can offer up my own attempt at developer docs made for my previous company (sadly already abandoned by the looks of it!)

I ended up including:

• an overview
• explanations of concepts
• tutorials walking through example code
• reference docs for each API feature
• an API reference

I can't speak to how useful my previous company's clients actually found this, though.

from electrodb.

Thank you @tywalch. This is already really helpful!

I missed your previous comment. Thanks, @asquithea for filling in.

from electrodb.