Skip to content
Browse files

Docfixes (closes #7348, #7778, #8669)

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7102 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent b0391d1 commit 3ae2bf09874294e018b23e89e1ce8278e950bf98 @dhh dhh committed Jun 23, 2007
Showing with 8 additions and 11 deletions.
  1. +6 −9 railties/README
  2. +1 −1 railties/doc/README_FOR_APP
  3. +1 −1 railties/lib/tasks/documentation.rake
View
15 railties/README
@@ -25,11 +25,11 @@ Rails. You can read more about Action Pack in
link:files/vendor/rails/actionpack/README.html.
-== Getting started
+== Getting Started
-1. At the command prompt, start a new rails application using the rails command
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
and your application name. Ex: rails myapp
- (If you've downloaded rails in a complete tgz or zip, this step is already done)
+ (If you've downloaded Rails in a complete tgz or zip, this step is already done)
2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
4. Follow the guidelines to start developing your application
@@ -38,11 +38,11 @@ link:files/vendor/rails/actionpack/README.html.
== Web Servers
By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
-Rails will use the WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
that you can always get up and running quickly.
-Mongrel is a Ruby-based webserver with a C-component (which requires compilation) that is
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
More info at: http://mongrel.rubyforge.org
@@ -111,11 +111,8 @@ Passing an argument will specify a different environment, like <tt>script/consol
To reload your controllers and models after launching the console run <tt>reload!</tt>
-To reload your controllers and models after launching the console run <tt>reload!</tt>
-
-
-== Description of contents
+== Description of Contents
app
Holds all the code that's specific to this particular application.
View
2 railties/doc/README_FOR_APP
@@ -1,2 +1,2 @@
Use this README file to introduce your application and point to useful places in the API for learning more.
-Run "rake appdoc" to generate API documentation for your models and controllers.
+Run "rake doc:app" to generate API documentation for your models and controllers.
View
2 railties/lib/tasks/documentation.rake
@@ -46,7 +46,7 @@ namespace :doc do
plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }
- desc "Generate documation for all installed plugins"
+ desc "Generate documentation for all installed plugins"
task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" }
desc "Remove plugin documentation"

0 comments on commit 3ae2bf0

Please sign in to comment.
Something went wrong with that request. Please try again.