linear-b · vim-zz · May 11, 2025 · May 11, 2025 · May 11, 2025 · May 11, 2025
diff --git a/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md b/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md
@@ -4,6 +4,7 @@ description: Notify PR authors to ensure proper Javadoc coverage.
 category: [docs, java]
 ---
 # Review Java Input Parameters for Javadoc Changes
+<!-- --8<-- [start:example]-->
 
 If a PR modifies the input parameters for a Java method, but not the associated Javadocs, notify reviewers to check for Javadoc updates.
 
@@ -35,3 +36,5 @@ If a PR modifies the input parameters for a Java method, but not the associated
       </span>
     </div>
 </div>
+
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md b/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md
@@ -4,6 +4,7 @@ description: Automatically flag large PRs that may require Javadoc updates.
 category: [docs, java]
 ---
 # Review Javadoc for Large Changes
+<!-- --8<-- [start:example]-->
 
 Require more extensive reviews for large Java changes that lack Javadoc updates.
 
@@ -35,3 +36,4 @@ Require more extensive reviews for large Java changes that lack Javadoc updates.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/javadoc/review-javadoc/README.md b/docs/automations/integrations/javadoc/review-javadoc/README.md
@@ -4,6 +4,7 @@ description: Automatically approve PRs that only contain Javadoc changes.
 category: [docs, java]
 ---
 # Review Javadoc Changes
+<!-- --8<-- [start:example]-->
 
 Unblock PRs that only change Javadoc content.
 
@@ -36,3 +37,4 @@ Unblock PRs that only change Javadoc content.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md b/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md
@@ -4,6 +4,7 @@ description: Automatically request changes for PRs that fail to meet Javadoc req
 category: [docs, java]
 ---
 # Enforce Javadoc Requirements for New Classes
+<!-- --8<-- [start:example]-->
 
 Automatically request changes when someone creates a new Java class that lacks Javadoc content.
 
@@ -34,3 +35,4 @@ Automatically request changes when someone creates a new Java class that lacks J
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jit/label-jit-alerts/README.md b/docs/automations/integrations/jit/label-jit-alerts/README.md
@@ -4,6 +4,8 @@ description: Automatically label PRs with Jit findings.
 category: [security, jit]
 ---
 # Label Jit Alerts
+<!-- --8<-- [start:example]-->
+
 Label the number of high, medium, and low risk vulnerabilities Jit reports for PRs.
 
 <div class="automationImage" markdown="1">
@@ -30,3 +32,4 @@ Label the number of high, medium, and low risk vulnerabilities Jit reports for P
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jit/review-jit-alerts/README.md b/docs/automations/integrations/jit/review-jit-alerts/README.md
@@ -4,6 +4,7 @@ description: Automatically assign PR reviewers for Jit security alerts.
 category: [security, jit]
 ---
 # Review Jit Security Alerts
+<!-- --8<-- [start:example]-->
 Manage review assignment for high and medium risk Jit security alerts.
 
 <div class="automationImage" markdown="1">
@@ -40,3 +41,4 @@ Manage review assignment for high and medium risk Jit security alerts.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jit/review-jit-ignore-accept/README.md b/docs/automations/integrations/jit/review-jit-ignore-accept/README.md
@@ -4,6 +4,7 @@ description: Automatically notify your security team when someone ignores Jit vu
 category: [security, jit]
 ---
 # Review Jit Ignore and Accept
+<!-- --8<-- [start:example]-->
 Notify your Security team when someone ignores a Jit vulnerability report and accepts the risk.
 
 <div class="automationImage" markdown="1">
@@ -33,3 +34,4 @@ Notify your Security team when someone ignores a Jit vulnerability report and ac
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jit/review-jit-secret/README.md b/docs/automations/integrations/jit/review-jit-secret/README.md
@@ -4,6 +4,7 @@ description: Automatically block PRs that contain secrets.
 category: [security, jit]
 ---
 # Review Jit Secret Detection
+<!-- --8<-- [start:example]-->
 Close PRs where Jit detects a secret and post a comment explaining steps to remedy the situation.
 
 <div class="automationImage" markdown="1">
@@ -32,3 +33,4 @@ Close PRs where Jit detects a secret and post a comment explaining steps to reme
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md
@@ -4,7 +4,7 @@ description: Automatically flag PRs that may require JSDoc updates.
 category: [docs, javascript]
 ---
 # Review JSDoc Input Parameters
-
+<!-- --8<-- [start:example]-->
 Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content.
 
 
@@ -34,3 +34,4 @@ Warn PR authors when they change JavaScript function or constructor input parame
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md
@@ -4,7 +4,7 @@ description: Automatically flag large PRs that may require JSDoc updates.
 category: [docs, javascript]
 ---
 # Review JSDoc for Large Changes
-
+<!-- --8<-- [start:example]-->
 Require more extensive reviews for large JavaScript changes that lack JSDoc updates.
 
 <div class="automationImage" markdown="1">
@@ -35,3 +35,4 @@ Require more extensive reviews for large JavaScript changes that lack JSDoc upda
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md
@@ -4,7 +4,7 @@ description: Enforce JSDoc requirements for PRs.
 category: [docs, javascript]
 ---
 # Enforce JSDoc for New JavaScript Classes
-
+<!-- --8<-- [start:example]-->
 Require JSDoc for all new JavaScript classes.
 
 
@@ -36,3 +36,4 @@ Require JSDoc for all new JavaScript classes.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/jsdoc/review-jsdoc/README.md b/docs/automations/integrations/jsdoc/review-jsdoc/README.md
@@ -4,7 +4,7 @@ description: Automatically approve PRs for JSDoc changes.
 category: [docs, javascript]
 ---
 # Review JSDoc Changes
-
+<!-- --8<-- [start:example]-->
 Approve PRs that only contain changes to JSDoc and assign optional reviewers.
 
 <div class="automationImage" markdown="1">
@@ -35,3 +35,4 @@ Approve PRs that only contain changes to JSDoc and assign optional reviewers.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md b/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md
@@ -4,6 +4,7 @@ description: Automatically approve PRs that pass SonarCloud's quality gate.
 category: [security, sonarcloud]
 ---
 # Approve Sonar Clean Code
+<!-- --8<-- [start:examples]-->
 
 Approve PRs that pass SonarCloud's quality gate.
 
@@ -34,3 +35,5 @@ Approve PRs that pass SonarCloud's quality gate.
       </span>
     </div>
 </div>
+
+<!-- --8<-- [end:examples]-->
diff --git a/docs/automations/integrations/sonar/label-sonar/README.md b/docs/automations/integrations/sonar/label-sonar/README.md
@@ -4,6 +4,8 @@ description: Automatically label PRs with SonarCloud insights.
 category: [security, sonarcloud]
 ---
 # Label SonarCloud Quality Reports
+<!-- --8<-- [start:examples]-->
+
 Label the number of bugs, vulnerabilities, security hotspots, and code smells reported by SonarCloud.
 
 <div class="automationImage" style="align:right" markdown="1">
@@ -30,3 +32,5 @@ Label the number of bugs, vulnerabilities, security hotspots, and code smells re
       </span>
     </div>
 </div>
+
+<!-- --8<-- [end:examples]-->
diff --git a/docs/automations/integrations/sonar/review-sonar-duplications/README.md b/docs/automations/integrations/sonar/review-sonar-duplications/README.md
@@ -4,6 +4,7 @@ description: Automatically request changes when SonarCloud detects duplicated co
 category: [security, sonarcloud]
 ---
 # Review Sonar Duplications
+<!-- --8<-- [start:examples]-->
 
 Request changes when Sonar reports an excessive level of duplicated code.
 
@@ -32,3 +33,5 @@ Request changes when Sonar reports an excessive level of duplicated code.
       </span>
     </div>
 </div>
+
+<!-- --8<-- [start:examples]-->
diff --git a/docs/automations/integrations/terraform/review-new-module/README.md b/docs/automations/integrations/terraform/review-new-module/README.md
@@ -6,6 +6,7 @@ quickstart: false
 ---
 
 # Review New Terraform Modules
+<!-- --8<-- [start:example]-->
 Request changes if a PR that creates a new Terraform module which do not conform to the required directory structure.
 
 <div class="automationImage" markdown="1">
@@ -37,3 +38,4 @@ Request changes if a PR that creates a new Terraform module which do not conform
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/terraform/review-terraform-module-name/README.md b/docs/automations/integrations/terraform/review-terraform-module-name/README.md
@@ -6,6 +6,7 @@ quickstart: false
 ---
 
 # Review Terraform Module Name
+<!-- --8<-- [start:example]-->
 Request changes if a PR creates a new Terraform module that is missing a required prefix or keyword in the name.
 
 <div class="automationImage" markdown="1">
@@ -35,3 +36,4 @@ Request changes if a PR creates a new Terraform module that is missing a require
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/terraform/review-terraform-source-version/README.md b/docs/automations/integrations/terraform/review-terraform-source-version/README.md
@@ -6,6 +6,7 @@ quickstart: false
 ---
 
 # Review Terraform Source Version
+<!-- --8<-- [start:example]-->
 Ensure that all Terraform modules imported via a source URL specify a version.
 
 <div class="automationImage" markdown="1">
@@ -35,3 +36,4 @@ Ensure that all Terraform modules imported via a source URL specify a version.
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/automations/integrations/terraform/review-terraform/README.md b/docs/automations/integrations/terraform/review-terraform/README.md
@@ -6,6 +6,7 @@ quickstart: false
 ---
 
 # Require Reviewers for Terraform changes
+<!-- --8<-- [start:example]-->
 Automatically assign `org/infrastructure` team for reviewing changes when PR contains Terraform file changes.
 
 <div class="automationImage" markdown="1">
@@ -34,3 +35,4 @@ Automatically assign `org/infrastructure` team for reviewing changes when PR con
       </span>
     </div>
 </div>
+<!-- --8<-- [end:example]-->
diff --git a/docs/integrations/LB_AI.md b/docs/integrations/LB_AI.md
@@ -7,15 +7,16 @@ category: [quality, genai, copilot, tests, efficiency]
 
 <!-- --8<-- [start:examples]-->
 
-## Add PR Description Using LinearB's AI :material-star-circle:
+## Automation Examples
+
+### Add PR Description Using LinearB's AI :material-star-circle:
 
 --8<-- "docs/automations/integrations/LinearBAI/describe-pr/README.md:example"
 
-## Use LinearB's AI for a comprehensive Code Review :material-star-circle:
+### Use LinearB's AI for a comprehensive Code Review :material-star-circle:
 
 --8<-- "docs/automations/integrations/LinearBAI/code-review/README.md:example"
 
-
 ## Additional Resources
 
 --8<-- "docs/snippets/general.md"

diff --git a/docs/integrations/askAI.md b/docs/integrations/askAI.md
@@ -11,27 +11,29 @@ category: [quality, genai, copilot, tests, efficiency]
 
     [Learn more about gitStream plugins](/plugins/).
 
-## Ask AI to Summarize the Changes in a PR
+## Automation Examples
+
+### Ask AI to Summarize the Changes in a PR
 
 --8<-- "docs/automations/integrations/askAI/summarize-pr/README.md:example"
 
-## Ask AI to Suggest Tests
+### Ask AI to Suggest Tests
 
 --8<-- "docs/automations/integrations/askAI/add-tests/README.md:example"
 
-## Ask AI for a Code Review
+### Ask AI for a Code Review
 
 --8<-- "docs/automations/integrations/askAI/code-review/README.md:example"
 
-## Ask AI for Documentation
+### Ask AI for Documentation
 
 --8<-- "docs/automations/integrations/askAI/document/README.md:example"
 
-## Ask AI for Code Improvements
+### Ask AI for Code Improvements
 
 --8<-- "docs/automations/integrations/askAI/improve/README.md:example"
 
-<!-- ## Ask AI for anything
+<!-- ### Ask AI for anything
 
 --8<-- "docs/automations/integrations/askAI/code-review/README.md:example" -->
 <!-- --8<-- [end:examples]-->

diff --git a/docs/integrations/claude-code.md b/docs/integrations/claude-code.md
@@ -4,12 +4,14 @@ description: Workflow automations to improve your Claude Code AI usage.
 ---
 # Integrate gitStream with Claude Code
 
-## Automatically Label Claude Code-Assisted PRs
+## Automation Examples
+
+### Automatically Label Claude Code-Assisted PRs
 
 --8<-- "docs/automations/integrations/claude-code/flag-claude-code-pr/README.md:example"
 
 ## Additional Resources
 
 --8<-- "docs/snippets/general.md"
 
---8<-- "docs/snippets/automation-footer.md"
+--8<-- "docs/snippets/automation-footer.md"
diff --git a/docs/integrations/cursor.md b/docs/integrations/cursor.md
@@ -4,12 +4,14 @@ description: Workflow automations to improve your Cursor AI usage.
 ---
 # Integrate gitStream with Cursor
 
-## Automatically Label Cursor-Assisted PRs
+## Automation Examples
+
+### Automatically Label Cursor-Assisted PRs
 
 --8<-- "docs/automations/integrations/cursor/flag-cursor-pr/README.md:example"
 
 ## Additional Resources
 
 --8<-- "docs/snippets/general.md"
 
---8<-- "docs/snippets/automation-footer.md"
+--8<-- "docs/snippets/automation-footer.md"
diff --git a/docs/integrations/github-copilot.md b/docs/integrations/github-copilot.md
@@ -4,15 +4,14 @@ description: Workflow automations to improve your GitHub Copilot usage.
 ---
 # Integrate gitStream with GitHub Copilot
 
+## Automation Examples
 
-## Automatically Label Copilot-Assisted PRs
+### Automatically Label Copilot-Assisted PRs
 
 --8<-- "docs/automations/integrations/copilot/flag-copilot-pr/README.md:example"
 
-
 ## Additional Resources
 
 --8<-- "docs/snippets/general.md"
 
---8<-- "docs/snippets/automation-footer.md"
-
+--8<-- "docs/snippets/automation-footer.md"
diff --git a/docs/integrations/godoc.md b/docs/integrations/godoc.md
@@ -4,13 +4,18 @@ description: Workflow automations for Godoc code reviews.
 ---
 # Integrate gitStream with Godoc
 
-## Review Godoc Changes
+## Automation Examples
+
+### Review Godoc Changes
+
 --8<-- "docs/automations/integrations/godoc/review-godoc/README.md:example"
 
-## Enforce Godoc Requirements for New Classes
+### Enforce Godoc Requirements for New Classes
+
 --8<-- "docs/automations/integrations/godoc/review-godoc-new-class/README.md:example"
 
-## Review Godoc for Large changes
+### Review Godoc for Large changes
+
 --8<-- "docs/automations/integrations/godoc/review-godoc-large/README.md:example"
 
 ## Additional Resources
@@ -19,5 +24,4 @@ description: Workflow automations for Godoc code reviews.
 
 --8<-- "docs/snippets/automation-footer.md"
 
-
-Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.
+Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.