Add quick-start documentation

[b-rowan]

One of the main objectives of v0.3.0 is to add documentation for quick start to lower the barrier to entry.

[easybe]

I'd be happy to document the Docker stuff. However, I would like to understand our documentation strategy first. Currently, there seems to be documentation in multiple places.

[b-rowan]

I'd be happy to document the Docker stuff. However, I would like to understand our documentation strategy first. Currently, there seems to be documentation in multiple places.

I think the documentation is basically all just getting compiled from the /docs folder. We could almost remove the README, but the github pages and the readthedocs are both from /docs.

[tsagadar]

This is the last issue for the 0.3.0 milestone. I think this task could be easier if we find a documentation we like from another (python/fastapi/readthedocs?) project. This could guide how to structure the documentation - what to put in the README.md and what in the other docu.

Would anyone know good examples?

[b-rowan]

Maybe we can start with something from this list?

https://kludex.github.io/awesome-fastapi-projects/

[tsagadar]

While looking for a docu template I found the following (based on nextra):
https://runtipi.io/docs/introduction

In my opinion, this is visually more pleasing than our current readthedocs documentation. The following site suggests, that readthedocs is rather a dead project - maybe have a look to change the tooling before starting the documentation?
https://npmtrends.com/docsify-vs-jekyll-vs-mdbook-vs-mkdocs-vs-nextra-vs-readthedocs

The top-level structure of the following nextra documentation looks quite good to me:
https://docs.cloudquery.io/docs

nextra deployment to GitHub page is not in the official documentation: shuding/nextra#2856

[b-rowan]

Seems fine. The goal with the GitHub pages deployment was just to be able to get a bit more SEO, but if we drop it that's fine. Not sure what the best way to do this is though, as it seems more like a full JS framework then a documentation handler?

[tsagadar]

Thinking a bit more about it: maybe better to get the content in place using the current solution. I'd assume that migrating to another framework should not be too hard.

Will try to come up with some draft PR in the next few days (or the coming weekend) with a proposed structure and some rough content.