Create a docs site for flaskerize

martinpeck commented 5 years ago

flaskerize would benefit from a quick start guide, and that guide should be part of a set of "official" documentation hosted on readthedocs.org. The creation of some basic docs will also allow other contributors to add/amend the docs over time.

The following structure should be created as a min:

[x] Short welcome/introduction to flaskerize
[x] Quick start guide: intro
[x] Quick start guide: setup and installation
[x] Quick start guide: creating the API
[x] Quick start guide: adding an entity to the API

martinpeck commented 5 years ago

Draft pull request #33 tracks the work in progress against this issue.

martinpeck commented 5 years ago

I've tackled all of the above to some level or other, so I'm going to tick the boxes for those tasks.

apryor6 commented 5 years ago

Closed by #33 and documentation is hosted on readthedocs here

apryor6 / flaskerize

Create a docs site for flaskerize #34