diff options
| author | Mike Gunderloy <MikeG1@larkfarm.com> | 2008-11-05 08:55:58 -0600 |
|---|---|---|
| committer | Mike Gunderloy <MikeG1@larkfarm.com> | 2008-11-05 08:55:58 -0600 |
| commit | 0fe9f9eb2c4feebc18498b0a6f8386dee95de0a2 (patch) | |
| tree | 3d937fa63f441f5a5d4396e1b69b789c9cd0fec8 | |
| parent | 37ea9de5af3fc8c133bbff060c11750bcb6970de (diff) | |
| download | rails-0fe9f9eb2c4feebc18498b0a6f8386dee95de0a2.tar.gz rails-0fe9f9eb2c4feebc18498b0a6f8386dee95de0a2.tar.bz2 rails-0fe9f9eb2c4feebc18498b0a6f8386dee95de0a2.zip | |
Add more documentation pointers to Getting Started Guide.
| -rw-r--r-- | railties/doc/guides/html/getting_started_with_rails.html | 13 | ||||
| -rw-r--r-- | railties/doc/guides/source/getting_started_with_rails.txt | 5 |
2 files changed, 18 insertions, 0 deletions
diff --git a/railties/doc/guides/html/getting_started_with_rails.html b/railties/doc/guides/html/getting_started_with_rails.html index 0f93c2bbf1..1b2eac0ce5 100644 --- a/railties/doc/guides/html/getting_started_with_rails.html +++ b/railties/doc/guides/html/getting_started_with_rails.html @@ -2009,6 +2009,19 @@ The <a href="http://wiki.rubyonrails.org/rails">Rails wiki</a> </p>
</li>
</ul></div>
+<div class="para"><p>Rails also comes with built-in help that you can generate using the rake command-line utility:</p></div>
+<div class="ilist"><ul>
+<li>
+<p>
+Running <tt>rake doc:guides</tt> will put a full copy of the Rails Guides in the <tt>/doc/guides</tt> folder of your application. Open <tt>/doc/guides/index.html</tt> in your web browser to explore the Guides.
+</p>
+</li>
+<li>
+<p>
+Running <tt>rake doc:rails</tt> will put a full copy of the API documentation for Rails in the <tt>/doc/api</tt> folder of your application. Open <tt>/doc/api/index.html</tt> in your web browser to explore the API documentation.
+</p>
+</li>
+</ul></div>
</div>
<h2 id="_changelog">10. Changelog</h2>
<div class="sectionbody">
diff --git a/railties/doc/guides/source/getting_started_with_rails.txt b/railties/doc/guides/source/getting_started_with_rails.txt index 49cc63d04f..f924d0793a 100644 --- a/railties/doc/guides/source/getting_started_with_rails.txt +++ b/railties/doc/guides/source/getting_started_with_rails.txt @@ -1224,6 +1224,11 @@ Now that you've seen your first Rails application, you should feel free to updat * The #rubyonrails channel on irc.freenode.net * The link:http://wiki.rubyonrails.org/rails[Rails wiki] +Rails also comes with built-in help that you can generate using the rake command-line utility: + +* Running +rake doc:guides+ will put a full copy of the Rails Guides in the +/doc/guides+ folder of your application. Open +/doc/guides/index.html+ in your web browser to explore the Guides. +* Running +rake doc:rails+ will put a full copy of the API documentation for Rails in the +/doc/api+ folder of your application. Open +/doc/api/index.html+ in your web browser to explore the API documentation. + == Changelog == http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/2[Lighthouse ticket] |