Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Setup using mkdocs #32

Closed
4 tasks done
ashwanthkumar opened this issue Oct 5, 2016 · 2 comments
Closed
4 tasks done

Documentation Setup using mkdocs #32

ashwanthkumar opened this issue Oct 5, 2016 · 2 comments
Milestone

Comments

@ashwanthkumar
Copy link
Owner

ashwanthkumar commented Oct 5, 2016

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
@ashwanthkumar ashwanthkumar changed the title Developer and User Documentation Documentation Setup using mkdocs Oct 5, 2016
@ashwanthkumar
Copy link
Owner Author

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
Copy link
Owner Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant