Skip to content

Commit bcc7bfd

Browse files
Merge branch 'main' into PORT-16654
2 parents de4d17c + 42079b9 commit bcc7bfd

File tree

3 files changed

+809
-30
lines changed

3 files changed

+809
-30
lines changed

best_practices.md

Lines changed: 15 additions & 29 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,34 +222,6 @@ Example code after:
208222

209223
___
210224

211-
<b>Pattern 8: Use sentence case for headers with only the first word capitalized, and ensure links follow capitalization rules based on their position in the sentence.</b>
212-
213-
Example code before:
214-
215-
```
216-
## Sync Approaches And Methods
217-
218-
Check out our [Guide](docs/guide.md) for more information.
219-
```
220-
221-
Example code after:
222-
223-
```
224-
## Sync approaches and methods
225-
226-
Check out our [guide](docs/guide.md) for more information.
227-
```
228-
229-
Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.
230-
231-
<details><summary>Examples for relevant past discussions:</summary>
232-
233-
<!-- Add links to relevant PR discussions here -->
234-
235-
</details>
236-
237-
___
238-
239225
<b>Pattern 9: Use "We" language instead of commanding "You" language to create a collaborative, guiding tone rather than issuing commands.</b>
240226

241227
Example code before:
@@ -699,4 +685,4 @@ Before submitting your contribution, review it against this checklist:
699685
- [ ] Tone is consistent with Port's documentation style
700686
- [ ] Content is organized logically
701687
- [ ] Technical terms are explained or linked to definitions
702-
- [ ] No unnecessary jargon or marketing language
688+
- [ ] No unnecessary jargon or marketing language

0 commit comments

Comments
 (0)