Skip to content

Commit a9a9c59

Browse files
authored
Add guidelines for describing interacting with panels (github#36383)
1 parent 1940b34 commit a9a9c59

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributing/content-style-guide.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -804,6 +804,17 @@ Describe a user interface element’s location with standard terms.
804804
- Upper-left, upper-right, lower-left, lower-right
805805
- Top of the page, bottom of the page, right side of the page, left side of the page
806806
807+
### Panels
808+
809+
When possible, avoid referring to panels. Instead, describe what someone needs to do.
810+
- **Use:** Click **View charts and graphs** for your repository, then select the time period you want to view from the dropdown menu.
811+
- **Avoid:** Click the **View charts and graphs** to open the panel for your selected repository, then select the time period you want to view from the dropdown menu.
812+
813+
If you need to refer to a panel to describe a change to the UI or to explain how to interact with the UI, format the panel name as [user interface text](#user-interface-text). Only include the word panel if it adds clarity or if the panel has no name in the UI.
814+
815+
- **Use:** In the "Security coverage" panel, select **Enable** or **Disable**.
816+
- **Use:** In the panel, select **Enable** or **Disable**.
817+
807818
### Radio buttons
808819
809820
Format radio button labels in bold and omit the words “radio button” or any other descriptor. To describe using a radio button, write "select."

0 commit comments

Comments
 (0)