Skip to content
Merged
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion docs/pages/contributing/documentation/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,21 @@ Specific kinds of architecture guides include:
- Should be easy to navigate with a browser's search functionality. List all content on the same page.
- Should avoid prose and be expressed with brevity.


## General style rules

Please refer to this style guide when determining how address questions about
English grammar, usage, and so on. Since many of these rules have equally
justifiable alternatives, a style guide prevents debates over these questions
from getting in the way of documenting Teleport.

<Notice type="tip">

If a commonly debated style question does not have a resolution in this guide
(e.g., the Oxford comma), all we ask is that you keep your style consistent
within a particular page to maintain a professional polish.

</Notice>

### Voice

The documentation should be technically precise and directed toward a technical
Expand Down