Skip to content

Commit 7bd9c87

Browse files
author
Zachary Scott
committed
Merge pull request rails#16453 from reshleman/re-cleanup-guides-guidelines
Cleanup Guides Guidelines [ci skip]
2 parents d0cdc96 + d71433d commit 7bd9c87

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

guides/source/ruby_on_rails_guides_guidelines.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ After reading this guide, you will know:
1313
Markdown
1414
-------
1515

16-
Guides are written in [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown). There is comprehensive [documentation for Markdown](http://daringfireball.net/projects/markdown/syntax), a [cheatsheet](http://daringfireball.net/projects/markdown/basics).
16+
Guides are written in [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown). There is comprehensive [documentation for Markdown](http://daringfireball.net/projects/markdown/syntax), as well as a [cheatsheet](http://daringfireball.net/projects/markdown/basics).
1717

1818
Prologue
1919
--------
2020

21-
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).
21+
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. As an example, see the [Routing Guide](routing.html).
2222

23-
Titles
23+
Headings
2424
------
2525

26-
The title of every guide uses `h1`; guide sections use `h2`; subsections `h3`; etc. However, the generated HTML output will have the heading tag starting from `<h2>`.
26+
The title of every guide uses an `h1` heading; guide sections use `h2` headings; subsections use `h3` headings; etc. Note that the generated HTML output will use heading tags starting with `<h2>`.
2727

2828
```
2929
Guide Title
@@ -35,14 +35,14 @@ Section
3535
### Sub Section
3636
```
3737

38-
Capitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be:
38+
When writing headings, capitalize all words except for prepositions, conjunctions, internal articles, and forms of the verb "to be":
3939

4040
```
4141
#### Middleware Stack is an Array
4242
#### When are Objects Saved?
4343
```
4444

45-
Use the same typography as in regular text:
45+
Use the same inline formatting as regular text:
4646

4747
```
4848
##### The `:content_type` Option
@@ -51,25 +51,23 @@ Use the same typography as in regular text:
5151
API Documentation Guidelines
5252
----------------------------
5353

54-
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):
54+
The guides and the API should be coherent and consistent where appropriate. In particular, these sections of the [API Documentation Guidelines](api_documentation_guidelines.html) also apply to the guides:
5555

5656
* [Wording](api_documentation_guidelines.html#wording)
5757
* [Example Code](api_documentation_guidelines.html#example-code)
58-
* [Filenames](api_documentation_guidelines.html#filenames)
58+
* [Filenames](api_documentation_guidelines.html#file-names)
5959
* [Fonts](api_documentation_guidelines.html#fonts)
6060

61-
Those guidelines apply also to guides.
62-
6361
HTML Guides
6462
-----------
6563

6664
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.
6765

68-
To install the latest version of Bundler, simply run the `gem install bundler` command
66+
To install the latest version of Bundler, run `gem install bundler`.
6967

7068
### Generation
7169

72-
To generate all the guides, just `cd` into the `guides` directory, run `bundle install` and execute:
70+
To generate all the guides, just `cd` into the `guides` directory, run `bundle install`, and execute:
7371

7472
```
7573
bundle exec rake guides:generate

0 commit comments

Comments
 (0)