From 4a1a018d62130310bb38857b908581f41c81f1ca Mon Sep 17 00:00:00 2001
From: "Mark D. Blackwell" <markdblackwell01@gmail.com>
Date: Tue, 20 Mar 2012 13:01:01 -0400
Subject: [ci skip] Make guides more readable & consistent

---
 .../source/ruby_on_rails_guides_guidelines.textile  | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'guides/source/ruby_on_rails_guides_guidelines.textile')

diff --git a/guides/source/ruby_on_rails_guides_guidelines.textile b/guides/source/ruby_on_rails_guides_guidelines.textile
index f3c8fa654d..f7d1ed8f65 100644
--- a/guides/source/ruby_on_rails_guides_guidelines.textile
+++ b/guides/source/ruby_on_rails_guides_guidelines.textile
@@ -1,20 +1,20 @@
 h2. Ruby on Rails Guides Guidelines
 
-This guide documents guidelines for writing guides. This guide follows itself in a gracile loop.
+This guide documents guidelines for writing Ruby on Rails Guides. This guide follows itself in a graceful loop, serving itself as an example.
 
 endprologue.
 
 h3. Textile
 
-Guides are written in "Textile":http://www.textism.com/tools/textile/. There's comprehensive documentation "here":http://redcloth.org/hobix.com/textile/ and a cheatsheet for markup "here":http://redcloth.org/hobix.com/textile/quick.html.
+Guides are written in "Textile":http://www.textism.com/tools/textile/. There is comprehensive "documentation":http://redcloth.org/hobix.com/textile/ and a "cheatsheet":http://redcloth.org/hobix.com/textile/quick.html for markup.
 
 h3. Prologue
 
-Each guide should start with motivational text at the top (that's the little introduction in the blue area.) The prologue should tell the reader what the guide is about, and what they will learn. See for example the "Routing Guide":routing.html.
+Each guide should start with motivational text at the top (that's the little introduction in the blue area). The prologue should tell the reader what the guide is about, and what they will learn. See for example the "Routing Guide":routing.html.
 
 h3. Titles
 
-The title of every guide uses +h2+, guide sections use +h3+, subsections +h4+, etc.
+The title of every guide uses +h2+; guide sections use +h3+; subsections +h4+; etc.
 
 Capitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be:
 
@@ -31,7 +31,7 @@ h6. The <tt>:content_type</tt> Option
 
 h3. API Documentation Guidelines
 
-The guides and the API should be coherent where appropriate. Please have a look at these particular sections of the "API Documentation Guidelines":api_documentation_guidelines.html:
+The guides and the API should be coherent and consistent where appropriate. Please have a look at these particular sections of the "API Documentation Guidelines":api_documentation_guidelines.html:
 
 * "Wording":api_documentation_guidelines.html#wording
 * "Example Code":api_documentation_guidelines.html#example-code
@@ -44,7 +44,7 @@ h3. HTML Guides
 
 h4. Generation
 
-To generate all the guides, just +cd+ into the +railties+ directory and execute:
+To generate all the guides, just +cd+ into the +guides+ directory and execute:
 
 <plain>
 bundle exec rake generate_guides
@@ -55,16 +55,17 @@ bundle exec rake generate_guides
 To process +my_guide.textile+ and nothing else use the +ONLY+ environment variable:
 
 <plain>
+touch my_guide.textile
 bundle exec rake generate_guides ONLY=my_guide
 </plain>
 
 By default, guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice.
 
-To force process of all the guides, pass +ALL=1+.
+To force processing all the guides, pass +ALL=1+.
 
 It is also recommended that you work with +WARNINGS=1+. This detects duplicate IDs and warns about broken internal links.
 
-If you want to generate guides in languages other than English, you can keep them in a separate directory under +source+ (eg. <tt>source/es</tt>) and use the +GUIDES_LANGUAGE+ environment variable:
+If you want to generate guides in a language other than English, you can keep them in a separate directory under +source+ (eg. <tt>source/es</tt>) and use the +GUIDES_LANGUAGE+ environment variable:
 
 <plain>
 bundle exec rake generate_guides GUIDES_LANGUAGE=es
@@ -78,11 +79,11 @@ Please validate the generated HTML with:
 bundle exec rake validate_guides
 </plain>
 
-Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a way to fix them.
+Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a solution.
 
 h3. Kindle Guides
 
-h4. Generation
+h4(#generation-kindle). Generation
 
 To generate guides for the Kindle, you need to provide +KINDLE=1+ as an environment variable:
 
-- 
cgit v1.2.3

