File tree Expand file tree Collapse file tree 1 file changed +27
-2
lines changed Expand file tree Collapse file tree 1 file changed +27
-2
lines changed Original file line number Diff line number Diff line change @@ -51,8 +51,33 @@ Use the same inline formatting as regular text:
51
51
##### The `:content_type` Option
52
52
```
53
53
54
- Linking to the API
55
- ------------------
54
+ Links
55
+ -----
56
+
57
+ Use descriptive links and avoid "here" and "more" links:
58
+
59
+ ``` markdown
60
+ # BAD
61
+ See the Rails Internationalization (I18n) API documentation for [more
62
+ details](i18n.html).
63
+
64
+ # GOOD
65
+ See the [Rails Internationalization (I18n) API documentation](i18n.html) for
66
+ more details.
67
+ ```
68
+
69
+ Use descriptive links for internal links as well:
70
+
71
+ ``` markdown
72
+ # BAD
73
+ We will cover this [below](#multiple-callback-conditions).
74
+
75
+ # GOOD
76
+ We will cover this in the [multiple callback conditions
77
+ section](#multiple-callback-conditions) shown below.
78
+ ```
79
+
80
+ ### Linking to the API
56
81
57
82
Links to the API (` api.rubyonrails.org ` ) are processed by the guides generator in the following manner:
58
83
You can’t perform that action at this time.
0 commit comments