changemewtf/gist:255cbac73ba21d93c43e

Created May 14, 2014 21:05

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/changemewtf/255cbac73ba21d93c43e.js"></script>
Save changemewtf/255cbac73ba21d93c43e to your computer and use it in GitHub Desktop.

Download ZIP

How to improve the Rails guides

Raw

gistfile1.md

The Rails Guides are static HTML, so it's incredibly easy to generate and preview them locally.

To get started:

git clone [email protected]:rails/rails.git
cd rails
bundle install --without db
cd guides
bundle exec rake guides:generate:html
open output/index.html

The docs themselves are written in plain old Markdown, in the guides/source directory.

Just edit them and run bundle exec rake guides:generate:html again to update your HTML.

Make sure to follow the Guides Guidelines.

When you're ready to make a pull request, fork rails/rails on GitHub, add your fork as a remote, push to it, and fire off your request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment