Skip to content

Commit 1659d81

Browse files
authored
Action-oriented TOC labels (#180)
* action-oriented TOC labels * autobuilder
1 parent f255e08 commit 1659d81

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

source/style-guide/style/toc-labels.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,13 @@ TOC Labels
113113
- In technical documentation, TOC labels may use specialized technical
114114
terminology and acronyms to accurately represent the content within
115115
each section or page.
116+
117+
- If a tutorial page uses an action-oriented TOC label, and that label fits on one line,
118+
use the action-oriented label. Note that a child page can "inherit" an action from a
119+
parent page; for example, if the parent TOC label is "Query", you can label its child
120+
pages "Arrays," "Nested Documents," etc., without repeating "Query" in the child labels.
121+
122+
If an action-oriented TOC label doesn't fit on one line, use a shorter,
123+
non-action-oriented label.
124+
125+
Don't use action-oriented TOC labels for reference pages.

0 commit comments

Comments
 (0)