Added header capitalization rules to the top of the best_practices

[sivanel97]

User description

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Added docs pages

Please also include the path for the added docs

• Quickstart (/)
• Blueprint (/platform-overview/port-components/blueprint)
• ...

Updated docs pages

Please also include the path for the updated docs

• Quickstart (/)
• Blueprint (/platform-overview/port-components/blueprint)
• ...

---

PR Type

Documentation

---

Description

• Moved header capitalization rules to top of style guide

• Improved documentation structure and readability

• Fixed trailing newline formatting issue

---

Diagram Walkthrough

flowchart LR
  A["best_practices.md"] -->|"Move capitalization rules section"| B["Rules now at top after title"]
  A -->|"Remove from middle section"| C["Previously after Pattern 8"]
  A -->|"Add newline"| D["Fix file ending"]

Loading

File Walkthrough

	Relevant files
Documentation	best_practices.md Reorganize capitalization rules to document top                    best_practices.md Relocated header capitalization rules section from middle of document to immediately after the main title Preserved all rule content including examples for sentence case and product name capitalization Fixed trailing newline at end of file for proper formatting +15/-13

---

[qodo-merge-pro]

PR Compliance Guide 🔍

(Compliance updated until commit 6506c14)

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Non-code Changes: The PR only updates documentation text and adds a checklist item, with no application code that performs or omits audit logging, so compliance cannot be determined from the diff. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: No identifiers: The changes are purely documentation content and do not introduce code identifiers whose naming can be evaluated for self-documenting quality. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: No error paths: The diff only modifies markdown documentation and does not include executable code where error handling or edge case management could be assessed. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: No user errors: Since only documentation text is changed and no user-facing error messages are added or modified, secure error handling cannot be evaluated from this PR. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: No logging code: The PR modifies only markdown documentation, without any logging statements to assess for structure or sensitive data exposure. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: No input handling: There are no changes to input processing, data handling, or security-relevant code in this documentation-only PR to evaluate against the criteria. Referred Code # 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> Example code before: ... (clipped 667 lines)

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

---

Previous compliance checks

Compliance check up to commit 6506c14

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed
⚪	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Not applicable: The PR only updates documentation content and adds no code paths affecting audit logging, so this checklist item cannot be evaluated from the diff. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Not applicable: This PR changes documentation only and introduces no executable error handling; compliance cannot be assessed from the provided diff. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Not applicable: No logging-related code was added; as this is a docs-only change, logging practices cannot be evaluated from the diff. Referred Code # 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> Example code before: ... (clipped 667 lines)
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Not applicable: This PR updates markdown documentation structure and checklist text without introducing input handling; security validation cannot be assessed from the diff. Referred Code # 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> Example code before: ... (clipped 667 lines)

[qodo-merge-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
best practice	Remove trailing whitespace for consistency Remove the trailing whitespace from the incorrect header example line to improve code cleanliness and avoid potential formatting inconsistencies. best_practices.md [7-8] -❌ "## Sync Approaches And Methods" +❌ "## Sync Approaches And Methods" ✅ "## Sync approaches and methods" Apply / Chat Suggestion importance[1-10]: 3 __ Why: The suggestion correctly identifies unnecessary trailing whitespace, and removing it is a good practice for code cleanliness, though its impact on rendering is minimal in this context.	Low
More

[aws-amplify-eu-west-1]

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2977.d2ngvl90zqbob8.amplifyapp.com