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
28 changes: 15 additions & 13 deletions best_practices.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Port documentation style guide

___

**Header capitalization rules:** Use sentence case for headers with only the first word capitalized.

❌ "## Sync Approaches And Methods"
✅ "## Sync approaches and methods"

Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.

❌ "aws"
✅ "AWS"

___

This document details guidelines for contributing to Port's documentation, and demonstrates how to correctly write and review documentation content.

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

___

**Header capitalization rules:** Use sentence case for headers with only the first word capitalized.

❌ "## Sync Approaches And Methods"
✅ "## Sync approaches and methods"

Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.

❌ "aws"
✅ "AWS"

___

<b>Pattern 9: Use "We" language instead of commanding "You" language to create a collaborative, guiding tone rather than issuing commands.</b>

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