A Rails engine to provide the ability to add documentation to a Rails application
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Documentation is a Rails engine which provides a complete system for managing a set of hierarchical documentation. Once installed in an application, you'll have a complete user interface for viewing as well as editing a set of markdown pages.
To get started, you need to add Documentation to your Gemfile and run
gem 'documentation', '~> 1.0.0'
Next, you'll need to run the setup generator which will add a route to your
config/routes.rbfile for the Documentation interface.
bundle exec rails generate documentation:setup
You now need to populate your database schema and load the initial documentation pages.
bundle exec rake db:migrate documentation:install_guides
Once this is done, you can go ahead and start up your Rails application and browse to
/docsto view your documentation system.