Merge pull request rails#19932 from axilleas/api_docs_guidelines

Make sure you execute rake rdoc from rails root directory [ci skip]
micahpotts · Apr 28, 2015 · 6ccf3bf · 6ccf3bf
2 parents 76fc205 + 86b6c77
commit 6ccf3bf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
@@ -16,7 +16,8 @@ RDoc
 ----
 
 The [Rails API documentation](http://api.rubyonrails.org) is generated with
-[RDoc](http://docs.seattlerb.org/rdoc/).
+[RDoc](http://docs.seattlerb.org/rdoc/). To generate it, make sure you are
+in the rails root directory, run `bundle install` and execute:
 
 ```bash
   bundle exec rake rdoc

diff --git a/guides/source/ruby_on_rails_guides_guidelines.md b/guides/source/ruby_on_rails_guides_guidelines.md
@@ -64,7 +64,9 @@ The guides and the API should be coherent and consistent where appropriate. In p
 HTML Guides
 -----------
 
-Before generating the guides, make sure that you have the latest version of Bundler installed on your system. As of this writing, you must install Bundler 1.3.5 on your device.
+Before generating the guides, make sure that you have the latest version of
+Bundler installed on your system. As of this writing, you must install Bundler
+1.3.5 or later on your device.
 
 To install the latest version of Bundler, run `gem install bundler`.
 
@@ -82,6 +84,8 @@ or
 bundle exec rake guides:generate:html
 ```
 
+Resulting HTML files can be found in the `./output` directory.
+
 To process `my_guide.md` and nothing else use the `ONLY` environment variable:
 
 ```