Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The diff is unreadably large, so I recommend not trying to and instead pulling down the branch letting jekyll serve the site locally (
cd docs; bundle install; bundle exec jekyll serve; open http://localhost:4000
).Important points:
docs/
folder rather thangh-pages
branch for easier updatingpuppet-lint.rc
and rake task.rake docs:generate
rebuilds the check documentation from the YARD commentsOver time, I'd like to move the rest of the comments over to using YARD and getting more of the docs being autogenerated, but this is a good start.