0.0
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
documentator provides templates of documentations and command-line utilities to add them to a project.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Runtime

>= 0
 Project Readme

documentator

documentator has one primary goal: having better docs on our projects.

documentator provides two main features to achieve that goal:

Installation

With bundler, add it to your Gemfile:

group :development do
  gem "documentator"
end

Usage

Commands should be used from the root directory of the current project.

Bootstrap

bootstrap provides a minimal set of documentation files. Those are empty, and they must be written for each project. The content is specific to each project:

  • What's the architecture? (providing a ditaa schema will earn you some extra karma points)
  • Dependencies?
  • Environnements?

As a treat, bootstrap generates a Gemfile in project/doc which includes Guide'em up. Guide'em up can be used to preview markdown file in a browser.

bundle exec documentator bootstrap

Importing templates

import provides templates for common documentation that should be the same from one project to another. Installing ElasticSearch is basically always the same. If there are projet specific particularities, you can always add them here.

bundle exec documentator list

A language can be specified to the list command.

bundle exec documentator list fr

A language must be specified to the import command.

bundle exec documentator import fr beanstalkd mongodb

Contribution

YES. We want contributions.

  • Adding a bootstrap's file is done by adding a file to lib/documentator/bootstrap.
  • Adding a templates's file is done by adding a file to lib/documentator/templates.

Copyright

MIT. See LICENSE for further details.