Cards
- Cards (or DocCards, as they are officially known) areused to link to child pages.
- Main navigation pages should include DocCards for the first level of child pages that are nested below that page in the site hierarchy.
Child Pages
- A shallow hierarchy (fewer levels of child pages) is preferable to a deeper hierarchy (more levels of child pages), as it prevents content from being buried under sub-menus.
- The maximum number of levels in a hierarchy is 3.
- Example: About (Level 1) → Get Involved (Level 2) → Events (Level 3)
Drawers
- Drawers are used to hide information on a page until the user clicks to open the drawer.
- Drawers keep a page from becoming long and overwhelming
- Use drawers sparingly. They are best for concealing information that not all users will need.
- If a page is long and the information is essential, consider moving content to a child page instead of using a drawer.
Admonitions
Note
- A note draws the user’s attention to useful information that they may need.
- It breaks the flow of the content to interject a comment.
Tip
- A tip points the user to resources or provides additional information about using a tool.
Info
- Info provides all other further information that is not considered a tip.
Warning
- Warning is used for low-level warnings.
Danger
- Danger is used for high-level warnings.
- Danger should be used sparingly.