Skip to content

docs: Misc style guide additions #24080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

docs: Misc style guide additions #24080

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b92d244
Update style-guide.mdx
jessiemongeon1 Oct 24, 2025
0e92210
Update style-guide.mdx
jessiemongeon1 Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs/content/references/contribute/style-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,17 @@ Do use serial commas.

##### Numbers {#numbers}

Do not write out numbers; always use the numerical value.
Do not write out numbers when referring to a number of items; always use the numerical value.

> The folder contains 24 files.
> One folder contains 7 files, and the other contains 24 files.
> At least 20 pieces of candy fell off the table.

Do write out numbers when they are grammatically part of the sentence.

> One can always include extra documentation to support the theory.
> The client checks if the checkpoint is the last one of the epoch.

##### Quotation marks

Do not use quotation marks.
Expand Down Expand Up @@ -175,6 +180,10 @@ For consistency, the Sui documentation must use the following terms and phrases
| **Never hyphenated** | key pair, layer 1, open source, use case | Keep these words separate, no hyphen |
| **Always hyphenated** | burn-only (currency supplies), depth-first search, multi-writer objects, off-chain, off-device, on-chain, on-device, One-Time Witness, peer-to-peer, proof-of-stake, single-writer objects | Maintain hyphen for clarity and correctness |
| **Word preference** | Use "might" in place of "may" | The word may has a secondary definition that implies permission rather than possibility. |
| **Word preference** | Do not start sentences with "Please note" or "Note" | It can be argued that any sentence could be prefaced with these words. |
| **Word preference** | Use "through" in place of "via" | Indicates a more direct action. |



### Nodes

Expand Down Expand Up @@ -293,6 +302,26 @@ Use bold for UI elements that appear on the screen, such as buttons, menu items,

Use bold sparingly for emphasis and only when necessary for clarity. Avoid overusing bold for general emphasis in body text.

#### Keyboard button text

Use the `<kbd>` tags around text that corresponds to a physical button on the keyboard.

<Tabs>
<TabItem value="example" label="Example" default>

Press <kbd>0</kbd>, <kbd>1</kbd>, or <kbd>2</kbd> to select a key scheme and then press <kbd>Enter</kbd>.

</TabItem>

<TabItem value="markdown" label="Markdown">

```
Press <kbd>0</kbd>, <kbd>1</kbd>, or <kbd>2</kbd> to select a key scheme and then press <kbd>Enter</kbd>.
```

</TabItem>
</Tabs>

#### Italic text

Use italics when introducing a new term for the first time.
Expand Down
Loading