diff --git a/docs/pages/contributing/documentation/style-guide.mdx b/docs/pages/contributing/documentation/style-guide.mdx index 67b91461a75eb..21992871272e6 100644 --- a/docs/pages/contributing/documentation/style-guide.mdx +++ b/docs/pages/contributing/documentation/style-guide.mdx @@ -111,7 +111,6 @@ 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 @@ -119,6 +118,14 @@ 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. + + +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. + + + ### Voice The documentation should be technically precise and directed toward a technical