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

Update/review documentation and examples #166

Open
6 tasks
kputnam opened this issue Jan 13, 2019 · 0 comments
Open
6 tasks

Update/review documentation and examples #166

kputnam opened this issue Jan 13, 2019 · 0 comments

Comments

@kputnam
Copy link
Owner

kputnam commented Jan 13, 2019

The API documentation at rubydoc.info is probably in decent shape, but I'm not sure if the YARD plugins are still working.

The human-readable documentation in doc/ could be stale. It might be time to update it, and maybe publish it somewhere else like readthedocs.io

Things to review:

  • README.md
  • examples/
  • notes/
  • API documentation
  • doc/
  • usage messages in bin/ and examples/
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