You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/source/ruby_on_rails_guides_guidelines.md
+10-12
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,17 @@ After reading this guide, you will know:
13
13
Markdown
14
14
-------
15
15
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).
17
17
18
18
Prologue
19
19
--------
20
20
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).
22
22
23
-
Titles
23
+
Headings
24
24
------
25
25
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>`.
27
27
28
28
```
29
29
Guide Title
@@ -35,14 +35,14 @@ Section
35
35
### Sub Section
36
36
```
37
37
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":
39
39
40
40
```
41
41
#### Middleware Stack is an Array
42
42
#### When are Objects Saved?
43
43
```
44
44
45
-
Use the same typography as in regular text:
45
+
Use the same inline formatting as regular text:
46
46
47
47
```
48
48
##### The `:content_type` Option
@@ -51,25 +51,23 @@ Use the same typography as in regular text:
51
51
API Documentation Guidelines
52
52
----------------------------
53
53
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:
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.
67
65
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`.
69
67
70
68
### Generation
71
69
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:
0 commit comments