-
Notifications
You must be signed in to change notification settings - Fork 14
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
Improve documentation for public consumption #9
Comments
We should also have a better list of features and publish the API docs somewhere maybe. There's probably some need to normalize and fix some of the scaladoc comments/documentation. |
In preparation for open-source, this cleans up some documentation and adds some more usage information — as a library or directly with the built-in drivers. #9
Improve scaladocs, and add publishing the scaladocs API to GitHub as part of the release lifecycle. E.g. https://alvinalexander.com/scala/how-to-generate-scala-documentation-scaladoc-command-examples |
Scaladoc looks good now. Adding publishing to pages. |
Some issues left regarding publishing Scaladocs: #41 |
Improve documentation such that it is consumable as an open-source project. This should include any basic rationale about tuning, why or when to use this, examples, dataset sizes we have, etc.
The text was updated successfully, but these errors were encountered: