Skip to content

Commit 6506c14

Browse files
authored
Added header capitalization rules to the top of the best_practices
1 parent aafc5f6 commit 6506c14

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

best_practices.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Port documentation style guide
22

3+
___
4+
5+
**Header capitalization rules:** Use sentence case for headers with only the first word capitalized.
6+
7+
❌ "## Sync Approaches And Methods"
8+
✅ "## Sync approaches and methods"
9+
10+
Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.
11+
12+
❌ "aws"
13+
✅ "AWS"
14+
15+
___
16+
317
This document details guidelines for contributing to Port's documentation, and demonstrates how to correctly write and review documentation content.
418

519
<b>Pattern 1: Always standardize collapsible details with bold titles and "(click to expand)" for consistency and usability across docs.</b>
@@ -208,18 +222,6 @@ Example code after:
208222

209223
___
210224

211-
**Header capitalization rules:** Use sentence case for headers with only the first word capitalized.
212-
213-
❌ "## Sync Approaches And Methods"
214-
✅ "## Sync approaches and methods"
215-
216-
Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.
217-
218-
❌ "aws"
219-
✅ "AWS"
220-
221-
___
222-
223225
<b>Pattern 9: Use "We" language instead of commanding "You" language to create a collaborative, guiding tone rather than issuing commands.</b>
224226

225227
Example code before:
@@ -683,4 +685,4 @@ Before submitting your contribution, review it against this checklist:
683685
- [ ] Tone is consistent with Port's documentation style
684686
- [ ] Content is organized logically
685687
- [ ] Technical terms are explained or linked to definitions
686-
- [ ] No unnecessary jargon or marketing language
688+
- [ ] No unnecessary jargon or marketing language

0 commit comments

Comments
 (0)