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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for public consumption #9

Closed
joshdevins opened this issue Mar 27, 2017 · 5 comments
Closed

Improve documentation for public consumption #9

joshdevins opened this issue Mar 27, 2017 · 5 comments
Assignees
@joshdevins
Labels
enhancement
Milestone
1.0.0

Comments

@joshdevins
Copy link
Collaborator

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.
@joshdevins joshdevins added this to the 1.0.0 milestone Mar 27, 2017
@joshdevins joshdevins changed the title Documentation for open-source Improve documentation for public consumption Apr 25, 2017
@joshdevins
Copy link
Collaborator Author

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.

joshdevins pushed a commit that referenced this issue Aug 18, 2017
Adds usage information to README
1356c60 
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
@joshdevins
Copy link
Collaborator Author

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

@joshdevins
Copy link
Collaborator Author

See: https://github.com/sbt/sbt-ghpages

@joshdevins
Copy link
Collaborator Author

Scaladoc looks good now. Adding publishing to pages.

joshdevins pushed a commit that referenced this issue Aug 21, 2017
Fixes scaladocs in preparation for publishing
a48789e 
#9
@joshdevins joshdevins self-assigned this Jan 19, 2018
@joshdevins joshdevins mentioned this issue Jan 19, 2018
Open
@joshdevins
Copy link
Collaborator Author

Some issues left regarding publishing Scaladocs: #41

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joshdevins joshdevins

Labels
enhancement
Milestone
1.0.0
Development

No branches or pull requests
1 participant
@joshdevins