Skip to content

Commit 7f5250e

Browse files
committed
Edits
1 parent 3707643 commit 7f5250e

File tree

7 files changed

+55
-22
lines changed

7 files changed

+55
-22
lines changed

source/style-guide/markup/directives/sharedinclude.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Shared Include
55
==============
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
713
The ``sharedinclude`` directive lets you source content from a file located in
814
the MongoDB internal `docs-shared <https://github.com/10gen/docs-shared>`__
915
repository. Use this directive when you need to keep the same content in sync

source/style-guide/markup/format/lists.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
Lists
33
=====
44

5+
.. contents:: On this page
6+
:local:
7+
:backlinks: none
8+
:depth: 2
9+
:class: singlecol
10+
511
Lists are body elements that organize information into adjacent blocks of
612
markup. Each level of a list must start and end with a blank line.
713

source/style-guide/markup/format/substitutions.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
Substitutions
33
=============
44

5+
.. contents:: On this page
6+
:local:
7+
:backlinks: none
8+
:depth: 2
9+
:class: singlecol
10+
511
In Snooty, you can use variables to represent a text value in the
612
rendered form of the documentation. These variables are called
713
source constants. When used consistently, they help prevent inconsistencies in

source/style-guide/style/abbreviations.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Abbreviations
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
915
- Unless an abbreviation is common, spell out the words of the
1016
abbreviation on the first use in an article or topic.
1117

source/style-guide/style/callouts.txt

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ You can use the following callouts:
6969

7070
Callout Guidelines
7171
------------------
72+
7273
When creating callouts, use the following guidelines:
7374

7475
- Use the callout type to convey the kind of information you want
@@ -78,18 +79,25 @@ When creating callouts, use the following guidelines:
7879
attempt to create callouts using boldface, headings, or custom
7980
:abbr:`CSS (Cascading Style Sheets)`.
8081

82+
- Don't stack multiple admonitions directly after one another, as these
83+
can be distracting for users. To avoid stacking admonitions, group
84+
supplemental information from admonitions into a dedicated section.
85+
86+
- Don't use admonitions in tables and option lists, if possible, because
87+
admonitions reduce scannability of tables and options lists.
88+
8189
- Avoid nesting callouts inside tables and other elements.
8290

8391
- Avoid nesting code blocks inside callouts.
8492

8593
- Place a callout as close as possible to the information that it
8694
emphasizes or clarifies.
8795

88-
- Don't "stack" callouts of the same type (for example, by following
89-
one labeled note directly with another labeled note). Instead, use
96+
- Avoid "stack" callouts of the same type. For example, avoid adding
97+
one labeled note directly after another labeled note. Instead, use
9098
separate paragraphs or an unordered list within a single callout.
9199
You can have callouts of different types follow one
92-
another.
100+
another, if necessary, but if possible, avoid such situations also.
93101

94102
The following callouts might appear in existing documentation but are
95103
deprecated. Don't use these callouts in new content:

source/style-guide/style/glossaries.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Glossaries
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
915
Create a glossary to document the following items:
1016

1117
- New, unfamiliar, or unique terms

source/style-guide/style/links-and-cross-references.txt

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -75,35 +75,30 @@ about MongoDB concepts can click through and explore the linked content.
7575
Avoid Inline References in Tutorials
7676
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7777

78-
- Don't add inline textual references in tutorials or stepped procedures.
78+
- Avoid adding inline textual references in tutorials or stepped procedures.
7979

80-
If users follow inline references while in the middle of a procedure, this complicates navigating back and reorienting themselves with
81-
their current step.
80+
If users follow inline references while in the middle of a procedure,
81+
they might have difficulty navigating back and reorienting themselves
82+
with their current step.
8283

83-
Inline textual references may be appropriate for more reference-heavy pages,
84-
or tasks that aren't part of a streamlined tutorial for a particular action.
85-
86-
- Don't stack multiple admonitions directly after one another, as these
87-
can be distracting for users. To avoid stacking admonitions, group
88-
supplemental information from admonitions into a dedicated section.
89-
90-
- Don't use admonitions in tables and option lists, if possible, because
91-
admonitions reduce scannability of tables and options lists.
84+
Inline textual references may be appropriate for more reference-heavy pages.
9285

9386
Minimize Repeated Links
9487
~~~~~~~~~~~~~~~~~~~~~~~
9588

9689
- Don't link to the same target multiple times in the same section.
9790

98-
If a page is long and contains many sections, you may link to a target
99-
once or twice from this page. This helps users who navigate to a section
100-
far down on a page and may miss the initial reference at the top of the
101-
page. However, don't link to a target more than twice on the same page.
91+
You may link to the same target more than once on the same page, but
92+
think carefully about whether it's absolutely necessary. For example,
93+
if a page is long and contains many sections, then it might be helpful
94+
to link to a target once or twice from this page to help users who
95+
navigate to a section far down on a page and may miss the initial
96+
reference at the top of the page.
10297

103-
- When adding repeated links, use the same style for each link.
98+
- If you add repeated links, use the same style for each link.
10499
Consider whether a plaintext link or a monospace link is appropriate.
105-
Plaintext links may be less visually distracting than monospace links,
106-
which have the surrounding block.
100+
Plaintext links might be less visually distracting than monospace links,
101+
which have a surrounding block.
107102

108103
Make Link Text Clear
109104
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)