spelling and grammer fixes (#799)

vim-zz · web-flow · commit 87801c159c2f · 2025-10-22T11:25:50.000+03:00
diff --git a/docs/automation-actions.md b/docs/automation-actions.md
@@ -48,7 +48,7 @@ For all other actions, gitStream executes the actions in the order they are list
 
 #### Dynamic actions arguments
 
-Arguments values a dynamic value is supported using expressions based on Jinja2 syntax, and includes gitStream context variables, for example:
+Argument values support dynamic values using expressions based on Jinja2 syntax, and include gitStream context variables, for example:
 
 ```yaml+jinja
 automations:
@@ -263,7 +263,7 @@ automations:
 
 #### `close` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
-This action, once triggered, close the PR without merging.
+This action, once triggered, closes the PR without merging.
 
 ```yaml+jinja title="example"
 automations:
diff --git a/docs/automations/automation-library.md b/docs/automations/automation-library.md
@@ -69,5 +69,5 @@ These examples provide useful components to use in other automations. These aren
 
 ## Contribute Your Idea
 
-!!! tip "Do you Have a great idea for an automation that should be included in this library?"
+!!! tip "Do you have a great idea for an automation that should be included in this library?"
     [Submit your configuration](https://github.com/linear-b/gitStream/issues/new?assignees=&labels=new-example&template=new_automation_example.md&title=New+Example%3A+) on GitHub. We'll recognize your contribution publicly (if you want) and might even send you some special swag for your contribution. 
diff --git a/docs/automations/languages/html/review-css-important/README.md b/docs/automations/languages/html/review-css-important/README.md
@@ -21,7 +21,7 @@ Flag the use of `!important` in CSS files and automatically request changes.
     Automation Actions:
 
     * Apply an orange label that says `⚠️ Includes !important tag`
-    * Request changes an post a comment asking the PR author to remove the important tage.
+    * Request changes and post a comment asking the PR author to remove the important tag.
 
 </div>
 <div class="automationExample" markdown="1">
diff --git a/docs/context-variables.md b/docs/context-variables.md
@@ -4,7 +4,7 @@ description: Context Variables enable gitStream to extract useful data from PRs.
 ---
 # Context variables
 
-Context variable are the inputs for the automation conditions or checks.
+Context variables are the inputs for the automation conditions or checks.
 
 !!! Legend
 
diff --git a/docs/custom-github-app.md b/docs/custom-github-app.md
@@ -184,7 +184,7 @@ You can now set up gitStream for a single repo, your GitHub organization or acro
         ```
 
         **GitHub Actions**
-        Once your gitStream configuration file is setup, you need a Github Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your repository's default branch (usually `master` or `main`) and add the following configuration:
+        Once your gitStream configuration file is setup, you need a GitHub Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your repository's default branch (usually `master` or `main`) and add the following configuration:
 
         ```yaml+jinja
         --8<-- "docs/downloads/gitstream.yml"
@@ -223,7 +223,7 @@ You can now set up gitStream for a single repo, your GitHub organization or acro
 
         **GitHub Actions**
 
-        Once your gitStream configuration file is set up, you will need to create a Github Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
+        Once your gitStream configuration file is set up, you will need to create a GitHub Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
 
         ```yaml+jinja
         --8<-- "docs/downloads/gitstream.yml"
@@ -259,7 +259,7 @@ You can now set up gitStream for a single repo, your GitHub organization or acro
 
         **GitHub Actions**
 
-        Once your gitStream configuration file is set up, you will need to create a Github Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
+        Once your gitStream configuration file is set up, you will need to create a GitHub Actions configuration file to trigger gitStream automations. Create a `.github/workflows/gitstream.yml` file in your `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
 
         ```yaml+jinja
         --8<-- "docs/downloads/gitstream.yml"
diff --git a/docs/examples.md b/docs/examples.md
@@ -4,14 +4,14 @@ description: Build your first gitStream automation in as little as two minutes.
 ---
 # gitStream Quickstart
 
-This page contains common gitStream configurations that are a great place to begin adopting a continuous merge mindset with gitStream. If you haven't already, you'll need to install gitStream to your [GitHub](github-installation.md) or [GitLab](gitlab-installation.md) organization before you can use these automations
+This page contains common gitStream configurations that are a great place to begin adopting a continuous merge mindset with gitStream. If you haven't already, you'll need to install gitStream to your [GitHub](github-installation.md) or [GitLab](gitlab-installation.md) organization before you can use these automations.
 
 !!! tip "Build your first gitStream automation in as little as two minutes."
-    These example are complete gitStream configuration files that you can download directly via the buttons below the examples and upload to the `.cm` directory of your repo. Alternatively, you can copy and paste the individual automations, but make sure you include all required declarations and any related custom expressions from the configuration to ensure everything works properly. 
+    These examples are complete gitStream configuration files that you can download directly via the buttons below the examples and upload to the `.cm` directory of your repo. Alternatively, you can copy and paste the individual automations, but make sure you include all required declarations and any related custom expressions from the configuration to ensure everything works properly. 
 
 ## Improve PR Context with Label Automation
 
-This CM automation contains a collection of workflows to automatically apply labels that to provide deeper context to code reviewers to help them more quickly triage and address incoming requests for reviews. Ideally, you should implement these automations across your entire git organization to maximize developer usage. 
+This CM automation contains a collection of workflows to automatically apply labels to provide deeper context to code reviewers to help them more quickly triage and address incoming requests for reviews. Ideally, you should implement these automations across your entire git organization to maximize developer usage. 
 
 The following example includes workflow automations to do the following:
 
diff --git a/docs/execution-model.md b/docs/execution-model.md
@@ -31,7 +31,7 @@ gitStream automations are triggered by events related to pull requests (PRs). Yo
 
 By default, gitStream evaluates any new commit pushed to the PR, triggering automation evaluation.
 
-Additionally, if any of the automation rules reference the following [`pr`](context-variables.md#pr) context variables: `pr.comments`, `pr.title`, `pr.description`, or `pr.labels`, gitStream shall trigger and will initiate automation rules evaluation where there are changes to the PR comments, title, description, or labels respectfully.
+Additionally, if any of the automation rules reference the following [`pr`](context-variables.md#pr) context variables: `pr.comments`, `pr.title`, `pr.description`, or `pr.labels`, gitStream shall trigger and will initiate automation rules evaluation where there are changes to the PR comments, title, description, or labels respectively.
 
 This allows for greater flexibility in the automation process, ensuring that the relevant automation rules are evaluated and triggered when necessary. The execution model ensures the automation process is streamlined, efficient, and effective.
 
@@ -317,7 +317,7 @@ automations:
 
 #### Branch regex pattern
 
-Trigger only specific automations branch pattern A, and trigger other automation for all other branches except those that fit the pattern REGEX_PATTERN
+Trigger only specific automations branch pattern A, and trigger other automation for all other branches except those that fit the pattern REGEX_PATTERN.
 
 ```yaml+jinja
 # Automation in this file will trigger only for branch pattern REGEX_PATTERN
diff --git a/docs/filter-functions.md b/docs/filter-functions.md
@@ -23,13 +23,13 @@ The following functions are supported in addition to the built-in functions prov
 | --------------------------------------------------------------------------------------------------------------------- | ---------------------- | ------------------------------- | ---------------------- |
 | [`capture`](#capture)<br />Find and return the first occurrence of a regex in the input string                        | String                 | `regex`                         | String                 |
 | [`difference`](#difference)<br />Given two lists, keep only items that are in the 1st list but not in the 2nd.        | [Objects]              | `list`                          | [Objects]              |
-| [`every`](#every)<br />Checks whether all element in the list are `true`                                              | [Bool]                 | -                               | Bool                   |
+| [`every`](#every)<br />Checks whether all elements in the list are `true`                                              | [Bool]                 | -                               | Bool                   |
 | [`filter`](#filter)<br />Reduce list of items into a list of same items that match the specified term                 | [String]<br />[Object] | `regex`, `term`, `list`, `attr` | [String]<br />[Object] |
 | [`includes`](#match)<br />Check if substring match                                                                    | String                 | `regex`, `term`, `list`         | Bool                   |
 | [`intersection`](#intersection)<br />Given two lists, keep only items that are in both lists.                         | [Objects]              | `list`                          | [Objects]              |
 | [`map`](#map)<br />Maps each object in a list into their specified attribute value                                    | [Object]               | `attr`                          | [Object]               |
 | [`match`](#match)<br />Maps list of items into a list of booleans that match the specified term                       | [String]<br />[Object] | `regex`, `term`, `list` `attr`  | [Bool]                 |
-| [`nope`](#nope)<br />Checks whether all element in the list are `false`                                               | [Bool]                 | -                               | Bool                   |
+| [`nope`](#nope)<br />Checks whether all elements in the list are `false`                                               | [Bool]                 | -                               | Bool                   |
 | [`reject`](#reject)<br />Inverse of [`filter`](#filter), the result list contains non-matching items                  | [String]<br />[Object] | `regex`, `term`, `list`, `attr` | [String]<br />[Object] |
 | [`some`](#some)<br />Checks whether at least one element in the list is `true`                                        | [Bool]                 | -                               | Bool                   |
 
@@ -42,7 +42,7 @@ The following functions are supported in addition to the built-in functions prov
 
 | Function                                                                                                                                                                 | Input                                                      | Args                                               | Output                  |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | -------------------------------------------------- | ----------------------- |
-| [`allDocs`](#alldocs)<br />Checks the list includes only images                                                                                                          | [`files`](./context-variables.md#files)                    | -                                                  | Bool                    |
+| [`allDocs`](#alldocs)<br />Checks if the list includes only documents                                                                                                          | [`files`](./context-variables.md#files)                    | -                                                  | Bool                    |
 | [`allImages`](#allimages)<br />Checks the list includes only images                                                                                                      | [`files`](./context-variables.md#files)                    | -                                                  | Bool                    |
 | [`allTests`](#alltests)<br />Checks the list includes only tests                                                                                                         | [`files`](./context-variables.md#files)                    | -                                                  | Bool                    |
 | [`checkDependabot`](#checkdependabot)<br />Extract version bump information from Dependabot PRs description                                                              | String - PR description                                    | -                                                  | [String]                |
@@ -55,9 +55,9 @@ The following functions are supported in addition to the built-in functions prov
 | [`extractJitFindings`](#extractjitfindings) :fontawesome-brands-github: <br />Get an object with a summary of the findings found by the Jit scan                         | [`pr`](./context-variables.md#pr)                          | -                                                  | Object                  |
 | [`extractSonarFindings`](#extractsonarfindings) :fontawesome-brands-github: <br />Get an object with a summary of the findings found by the SonarCloud scan              | [`pr`](./context-variables.md#pr)                          | -                                                  | Object                  |
 | [`explainRankByGitBlame`](#explainrankbygitblame)<br />Short markdown text explaining rankByGitBlame results                                                             | [`repo`](./context-variables.md#repo)                      | `gt`, `lt`                                         | [String]                |
-| [`isFirstCommit`](#isfirstcommit)<br />Checks if its the author first commit in the repo                                                                                 | [`repo.contributors`](./context-variables.md#repo)         | String                                             | Bool                    |
+| [`isFirstCommit`](#isfirstcommit)<br />Checks if it's the author's first commit in the repo                                                                                 | [`repo.contributors`](./context-variables.md#repo)         | String                                             | Bool                    |
 | [`isFormattingChange`](#isformattingchange)<br />Checks that only formatting changed                                                                                     | [[`FileDiff` ](./context-variables.md#filediff-structure)] | -                                                  | Bool                    |
-| [`mapToEnum`](#maptoenum)<br />return the enum value matches to the input key                                                                                            | String                                                     | Enum object                                        | Object                  |
+| [`mapToEnum`](#maptoenum)<br />return the enum value that matches the input key                                                                                            | String                                                     | Enum object                                        | Object                  |
 | [`matchDiffLines`](#matchdifflines)<br />Match every line in diff                                                                                                        | [[`FileDiff` ](./context-variables.md#filediff-structure)] | `regex`, `ignoreWhiteSpaces`                       | [Bool]                  |
 | [`rankByGitActivity`](#rankbygitactivity)<br />Get list of contributors based on `git-commit` activity                                                                   | [`repo`](./context-variables.md#repo)                      | `gt`, `lt`                                         | [String]                |
 | [`rankByGitBlame`](#rankbygitblame)<br />Get list of contributors based on `git-blame` results                                                                           | [`repo`](./context-variables.md#repo)                      | `gt`, `lt`                                         | [String]                |
@@ -123,7 +123,7 @@ Given two lists, keep only items that are in the 1st list but not in the 2nd.
 
 #### `every`
 
-Checks whether all element in the list are `true`. In case the list of elements is empty, it will return `false`.
+Checks whether all elements in the list are `true`. In case the list of elements is empty, it will return `false`.
 
 <div class="filter-details" markdown=1>
 
@@ -623,7 +623,7 @@ For example, check that only one file type was changed:
 
 !!! Warning ":fontawesome-brands-github: Available in GitHub only"
 
-    This filter is currently availalbe only in GitHub
+    This filter is currently available only in GitHub
 
 Get an object with a summary of the findings found by [Jit](https://www.jit.io/) scan. This filter is relevant only for repos that use Jit to scan PRs
 
@@ -708,7 +708,7 @@ automations:
 #### `extractSonarFindings`
 !!! Warning ":fontawesome-brands-github: Available in GitHub only"
 
-    This filter is currently availalbe only in GitHub
+    This filter is currently available only in GitHub
 
 Get an object with a summary of the findings found by the SonarCloud scan. This filter is relevant only for repos that use SonarCloud to scan PRs
 
@@ -842,15 +842,15 @@ Note the comment starts with `|` and a `new-line` as `explainRankByGitBlame` gen
 
 #### `isFirstCommit`
 
-Return `true` if it's the author first commit in the repo.
+Return `true` if it's the author's first commit in the repo.
 
 <div class="filter-details" markdown=1>
 
 | Argument       | Usage    | Type   | Description                                     |
 | ------------ | ---------|--------|------------------------------------------------ |
 | -     | Input    | [`repo.contributors`](./context-variables.md#repo)  | List of contributors in the repo |
 | -     | Input    | String  | The contributor name |
-| -     | Output   | Bool   | `true` if its the first commit of the selected contributor |
+| -     | Output   | Bool   | `true` if it's the author's first commit of the selected contributor |
 
 </div>
 
diff --git a/docs/github-installation.md b/docs/github-installation.md
diff --git a/docs/how-it-works.md b/docs/how-it-works.md
diff --git a/docs/quick-start.md b/docs/quick-start.md
