search

ashwanthkumar / suuchi

सूचि - Toolkit to build Distributed Data Systems
https://ashwanthkumar.github.io/suuchi/
53 stars 12 forks source link

Documentation Setup using mkdocs #32

Closed ashwanthkumar closed 7 years ago

ashwanthkumar commented 7 years ago

Some PRs have really nice commit messages and discussions (#27 being my favourite). We should start documenting the internal decisions and workings of the system in a markdown somewhere so we could generate a documentation if needed in a later point of time.

We should surface the examples much more as something like recipes which folks could just copy-paste and take it from there. Also with #12 we should write scaladocs for external facing APIs.

A quickstart guide for general users of the library would also be great. We've already made an attempt as part of #19 but we could do better.

ashwanthkumar commented 7 years ago

As part of #33 we got our mkdocs based documentation setup and available at http://ashwanthkumar.github.io/suuchi/. I'm tracking very specific things to be added to the documentation as part of this issue and will close it.

ashwanthkumar commented 7 years ago

@brewkode I've the first cut of Quick Start documented at http://ashwanthkumar.github.io/suuchi/quick-start/ - please do have a look and let me know your feedback.