Skip to content

Commit 8620322

Browse files
committed
219-7 Minor changes and updates
1 parent b7e2fef commit 8620322

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed

config/style-guide/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ markdown_extensions:
7676
- tables
7777
- pymdownx.details
7878
- pymdownx.keys
79+
- pymdownx.tilde
7980
- pymdownx.smartsymbols
8081
- pymdownx.superfences
8182
- pymdownx.tabbed:

docs/style-guide/style-conventions.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: 12
3-
revision: 6
3+
revision: 7
44
hide:
55
- navigation
66
---
@@ -37,7 +37,7 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
3737

3838
## Capitalization
3939

40-
- Use sentence-style capitalization, including [titles](#titles). That means everything is lowercase except the first word, proper nouns, like the [Status product names](#product-and-user-interface-names).
40+
- Use sentence-style capitalization, including [titles](#titles). That means everything is lowercase except the first word, proper nouns, like the [Status product names](#product-names-and-user-interface-areas).
4141

4242
| Usage | Example |
4343
|:------------|:--------------------------------------------|
@@ -372,8 +372,9 @@ When you describe a UI interaction, use these action verbs:
372372
|:---|:---|
373373
| Go to a menu or screen | Use *go to*. |
374374
| Click a URL | For URLs, the verb depends on the user's intent:</br>- To complete another action (for example, to download something), use *visit*.</br>- To review the information on a different article or website, use *check*. |
375-
| Click a single UI element | *click* (desktop and web) or *tap* (mobile). |
376-
| Click multiple UI elements | *choose* for desktop, web, and mobile. |
375+
| Select a single UI element | *click* (desktop and web) or *tap* (mobile). |
376+
| Select multiple UI elements | *choose* for desktop, web, and mobile. |
377+
| Select text | *select* |
377378
| Acion on checkboxes | *check* the [UI label] box (to enable) / *uncheck* the [UI label] box (to disable). |
378379
| Go to previous screen | Use *return*. |
379380
| Swipe element | Use *swipe* [left or right] for desktop, web, and mobile. |
@@ -401,14 +402,23 @@ The Status documentation uses the application icons to guide readers' actions on
401402

402403
- Use icons in procedural steps to guide the user's actions.
403404
- Don't overuse icons. A document with many icons is harder to follow and scan.
404-
- Write the icon first, and then the icon's label. If the icon doesn't show a label in the UI, use the icon's name (or any other name that represents the icon's function) and add this to the [Products and user interface names](#product-and-user-interface-names) list.
405+
- Write the icon first, and then the icon's name. If the icon doesn't show a label in the UI, use the icon's name in the the [Icons names](#icon-names) reference table.
405406
- Use the Status icons on the `/override/.icons/status` folder in the GitHub [user documentation repository :octicons-tab-external-16:][status-github-user-doc-repo]{:target="_blank"}.
406407
- To reference these icons anywhere on the Markdown file, use the `:icon-name:` notation right before the icon's name. For example, the Status wallet icon under the `.icons` directory is `status-wallet.svg`; to show this icon in a sentence, use:
407408

408409
```text
409410
Tap :status-wallet: Wallet and save your settings.
410411
```
411412
413+
## Symbols and punctuation marks
414+
415+
To spell out symbols and punctuations marks, use the [List of typographical symbols and punctuation marks :octicons-tab-external-16:][wikipedia-symbols-and-marks]{:target="_blank"} article from Wikipedia.
416+
417+
| Usage | Example |
418+
|:------------|:------------------------------------------------------------------------|
419+
| **Correct** | To quote text inline, use the greater-than sign (`>`) before your text. |
420+
| Incorrect | To quote text inline, use the bigger-than sign (`>`) before your text. |
421+
412422
## Modal verbs
413423
414424
Modal verbs are auxiliary verbs that modify the meaning of the main verb in a sentence. Modal verbs can be problematic in technical communication:
@@ -552,9 +562,9 @@ Modal verbs are auxiliary verbs that modify the meaning of the main verb in a se
552562
| Apple Silicon | Apple silicon |
553563
| Intel (processor) | Intel processor |
554564
555-
## Product names and user interface areas
565+
## Naming products, user interface areas, and icons
556566
557-
Product and user interface names include:
567+
Products and user interface areas names include:
558568
559569
- Status apps features (for example, Status Communities).
560570
- Products and services that are part of the [Status Network :octicons-tab-external-16:](https://statusnetwork.com/){:target="_blank"} (for example, Keycard).
@@ -563,11 +573,14 @@ Product and user interface names include:
563573
!!! info
564574
Observe the capitalization convention. For example, use *Activity Center* and not *activity center*.
565575
576+
### Products and user interface areas reference
577+
566578
| Product/UI name | Notes |
567579
|:---|:---|
568580
| Status Communities | Include *Status* the first time you write about Communities in the body text. |
569581
| Activity Center | UI area where users can review and respond to activity notifications (:status-notification:) |
570582
| profile picture | Clickable UI element with the user's picture |
583+
| formatting toolbar | Toolbar showing the text formatting options |
571584
572585
### Status Desktop and Status Web main UI areas
573586
@@ -588,6 +601,12 @@ This picture describes the main user interface areas for Status Web and Status D
588601
| E | channel information at the top of the content area |
589602
| F | pinned messages area |
590603
604+
### Icon names
605+
606+
| Name | Icon |
607+
|:--------|:--------------------|
608+
| members | :status-group-chat: |
609+
591610
<br>[:octicons-git-branch-24: Contribute to our docs][contributors-guide]{ .md-button }</br>
592611
593612
--8<-- "includes/urls-style-guide.txt"

includes/urls-style-guide.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@
1515
[status-help]: https://help.status.im/
1616
[wikipedia-common-currencies]: https://en.wikipedia.org/wiki/Template:Most_traded_currencies
1717
[wikipedia-metric-system]: https://en.wikipedia.org/wiki/Metric_system
18-
[wikipedia-noun-phrases]: https://en.wikipedia.org/wiki/Noun_phrase
18+
[wikipedia-noun-phrases]: https://en.wikipedia.org/wiki/Noun_phrase
19+
[wikipedia-symbols-and-marks]: https://en.wikipedia.org/wiki/List_of_typographical_symbols_and_punctuation_marks

0 commit comments

Comments
 (0)