contributor docs: Add formatting instructions for streams and topics.

This commit is contained in:
Alya Abbott 2022-12-01 15:52:09 -08:00 committed by Tim Abbott
parent ec74416e5d
commit 3fe028f2f7
1 changed files with 1 additions and 1 deletions

View File

@ -213,7 +213,7 @@ as guidance when documenting Zulip's features.
When you refer to the features in the Zulip UI, you should **bold** the When you refer to the features in the Zulip UI, you should **bold** the
feature's name followed by the feature itself (e.g. **Settings** page, feature's name followed by the feature itself (e.g. **Settings** page,
**Change password** button, **Email** field). No quotation marks should be **Change password** button, **Email** field). No quotation marks should be
used. used. Use **bold** for stream names, and quotation marks for topic names.
Keep in mind that the UI may change — dont describe it in more detail than Keep in mind that the UI may change — dont describe it in more detail than
is needed. **Never identify or refer to a button by its color.** is needed. **Never identify or refer to a button by its color.**