Skip to content

Commit

Permalink
Add images section (#4412)
Browse files Browse the repository at this point in the history
Signed-off-by: natebower <[email protected]>
  • Loading branch information
natebower committed Jun 28, 2023
1 parent 31c8e1e commit 81836ba
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,6 @@ The following table lists acronyms that you don't need to spell out.

- Use bold text for all UI elements, including pages, panes, and dialog boxes. In all cases, emphasize what the user must do as opposed to talking about the UI element itself.

- Reference images in the text that precedes them. For example, "..., as shown in the following image."

- Stacked headings should never appear in our content. Stacked headings are any two consecutive headings without intervening text. Even if it is just an introductory sentence, there should always be text under any heading.

- Use italics for the titles of books, periodicals, and reference guides. However, do not use italics when the title of a work is also a hyperlink.
Expand All @@ -171,6 +169,16 @@ The following table lists acronyms that you don't need to spell out.
2. When referring to API operations by the exact name of the endpoint, use lowercase with code format (example: "`_field_caps` API").
3. When describing API operations but not using the exact name of the endpoint, use lowercase (example: "field capabilities API operations" or "field capabilities operations").

### Images

- Add introductory text that provides sufficient context for each image.

- Add ALT text that describes the image for screen readers.

- When you’re describing the location of an image, use words such as *preceding*, *previous*, or *following* instead of *above* and *below*.

- Text that introduces an image should be a complete sentence and end with a period, not a colon.

### Links

- **Formal cross-references**: In most cases, a formal cross-reference (the title of the page you're linking to) is the preferred style because it provides context and helps readers understand where they're going when they choose the link. Follow these guidelines for formal cross-references:
Expand Down

0 comments on commit 81836ba

Please sign in to comment.