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

Better documentation #109

Merged
merged 17 commits into from
Oct 15, 2016
Merged

Better documentation #109

merged 17 commits into from
Oct 15, 2016

Conversation

smellsblue
Copy link
Contributor

@smellsblue smellsblue commented Oct 13, 2016

This PR makes the following changes:

  • Refactor docs a bit, in particular, break out the reference into separate documents per command
  • Embed docs in the gem, and use man to output the docs when gemstash help is run, and embedded txt files when man is unavailable
  • Use pandoc to generate all docs from a single source (it generates the new embedded docs, the github markdown docs, and the soon to come html docs)
  • Drop the table of contents Rake task, since the new docs structure doesn't need it anymore
  • Auto generate the docs when building the gem
  • Reduce contents of the built gem to just the lib, and exe dirs, the license, changlog, and code of conduct

This fixes #96

@indirect
Copy link
Member

Prettttttty great. 👍 from me!

@smellsblue smellsblue merged commit 84f7e2d into 1-0-stable Oct 15, 2016
@smellsblue smellsblue deleted the better-documentation branch October 15, 2016 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants