You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Basic Documentation Infra
Add examples as recipes
Quick Start
Getting Started
The text was updated successfully, but these errors were encountered:
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.
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.
The text was updated successfully, but these errors were encountered: