docs: fix grammar

il-dat · il-dat · commit fc5065ad95de · 2025-09-15T10:17:10.000+07:00
diff --git a/docs/index.md b/docs/index.md
@@ -104,7 +104,7 @@ dbterd run -ad samples/local -rt model -rt source
 
 ### Python API Examples
 
-- Generate Complete ERD:
+- Generate a Complete ERD:
 
 ```python
 from dbterd.api import DbtErd
@@ -118,7 +118,7 @@ erd = DbtErd(target="mermaid").get_erd()
 print("ERD (Mermaid):", erd)
 ```
 
-- Generate Single Model ERD:
+- Generate a Single Model ERD:
 
 ```python
 from dbterd.api import DbtErd
diff --git a/docs/nav/guide/choose-algo.md b/docs/nav/guide/choose-algo.md
@@ -58,14 +58,14 @@ Ref: "order_items"."order_id" > "orders"."order_id"
 
 Awesome, job done here 🎉
 
-NO, not yet (maybe!), sometime this module is not going to work perfectly due to:
+NO, not yet (maybe!), sometimes this module is not going to work perfectly due to:
 
 - Some relationship tests are added from `mart` to `staging` just for ensuring no missing data when moving from a layer to another.
     - That's why we have the [ignore_in_erd](https://dbterd.datnguyen.de/1.15/nav/metadata/ignore_in_erd.html) metadata config.
 - We have the tests done in separate tools already (e.g. Soda), there is no reason to duplicate the (relationship) tests here.
     - No problem! Let's still add it with `where: 1=0` or with the dummy relationship tests (see this [blogpost](https://medium.com/@vaibhavchopda04/generating-erds-from-dbt-projects-a-code-driven-approach-83abb957f483))
 
-In case that we don't want to leverage the dbt tests still, let's move on the next section for the alternative 🏃
+In case we don't want to leverage the dbt tests still, let's move on to the next section for the alternative 🏃
 
 ## Semantic Entities
 
diff --git a/docs/nav/guide/cli-references.md b/docs/nav/guide/cli-references.md
@@ -71,7 +71,7 @@ Command to generate diagram-as-a-code file from dbt artifact files, optionally d
     from Administrative API (dbt Cloud) before hands.
 
     Options:
-      -s, --select TEXT               Selecttion criteria
+      -s, --select TEXT               Selection criteria
       -ns, --exclude TEXT             Exclusion criteria
       -t, --target TEXT               Target to the diagram-as-code platform
                                       [default: dbml]
@@ -140,7 +140,7 @@ Command to generate diagram-as-a-code file from dbt artifact files, optionally d
 ### dbterd run --select (-s)
 
 Selection criteria.
-> Select all dbt models if not specified, supports multiple options
+> Selects all dbt models if not specified, supports multiple options
 
 Rules:
 
@@ -211,7 +211,7 @@ Rules:
 ### dbterd run --exclude (-ns)
 
 Exclusion criteria. Rules are the same as Selection Criteria.
-> Do not exclude any dbt models if not specified, supports multiple options
+> Does not exclude any dbt models if not specified, supports multiple options
 
 **Examples:**
 === "CLI"
@@ -229,7 +229,7 @@ Exclusion criteria. Rules are the same as Selection Criteria.
 
 Configure the path to directory containing dbt artifact files.
 
-It will take the the nested `/target` directory of `--dbt-project-dir` if not specified.
+It will take the nested `/target` directory of `--dbt-project-dir` if not specified.
 
 > Default to the current directory's `/target` if both this option and `--dbt-project-dir` option are not specified
 
@@ -321,7 +321,7 @@ Supported target, please visit [Generate the Targets](https://dbterd.datnguyen.d
 
 ### dbterd run --algo (-a)
 
-Specified algorithm in the way to detect diagram connectors
+Specified algorithm for detecting diagram connectors
 
 Check the [docs](./choose-algo.md) 📖
 
@@ -471,7 +471,7 @@ Flag to indicate the Selection to follow dbt's one leveraging Programmatic Invoc
 
 Flag to indicate force running `dbt docs generate` to the targeted project in order to produce the dbt artifact files.
 
-This option have to be enabled together with `--dbt` option, and will override the value of `--artifacts-dir` to be using the `/target` dir of the value of `--dbt-project-dir`.
+This option has to be enabled together with `--dbt` option, and will override the value of `--artifacts-dir` to use the `/target` dir of the value of `--dbt-project-dir`.
 
 > Default to `False`
 
@@ -486,7 +486,7 @@ This option have to be enabled together with `--dbt` option, and will override t
 
 Specified dbt project directory path
 
-You should specified this option if your CWD is not the dbt project dir, and normally used with `--dbt` enabled. It will take the value of `--artifacts-dir` if not specified.
+You should specify this option if your CWD is not the dbt project dir, and normally used with `--dbt` enabled. It will take the value of `--artifacts-dir` if not specified.
 
 > Default to the current directory if both this option and `--artifacts-dir` option are not specified
 
@@ -623,7 +623,7 @@ Check [this guideline](./dbt-cloud/read-artifact-from-an-environment.md) for mor
     Generate ERD file from reading Discovery API (dbt Cloud).
 
     Options:
-      -s, --select TEXT               Selecttion criteria
+      -s, --select TEXT               Selection criteria
       -ns, --exclude TEXT             Exclusion criteria
       -t, --target TEXT               Target to the diagram-as-code platform
                                       [default: dbml]
@@ -738,7 +738,7 @@ Shows hidden configured values, which will help us to see what configs are passe
     Inspect the hidden magics.
 
     Options:
-      -s, --select TEXT               Selecttion criteria
+      -s, --select TEXT               Selection criteria
       -ns, --exclude TEXT             Exclusion criteria
       -t, --target TEXT               Target to the diagram-as-code platform
                                       [default: dbml]
diff --git a/docs/nav/guide/dbt-cloud/download-artifact-from-a-job-run.md b/docs/nav/guide/dbt-cloud/download-artifact-from-a-job-run.md
@@ -21,7 +21,7 @@ Behind the scene, the API Endpoint will look like:
 https://{host_url}/api/{api_version}/accounts/{account_id}/runs/{run_id}/artifacts/{path}
 ```
 
-And the dbt Cloud's Job Rub will have the URL constructed as:
+And the dbt Cloud's Job Run will have the URL constructed as:
 
 ```log
 https://<host_url>/deploy/<account_id>/projects/irrelevant/runs/<run_id>
@@ -69,7 +69,7 @@ $env:DBTERD_DBT_CLOUD_API_VERSION="your_value" # optional, default = v2
 
 We're going to use `--dbt-cloud` option to tell `dbterd` to use dbt Cloud API with all above variables.
 
-The command will be looks like:
+The command will look like:
 
 ```bash
 dbterd run --dbt-cloud [-s <dbterd selection>]
diff --git a/docs/nav/guide/dbt-cloud/read-artifact-from-an-environment.md b/docs/nav/guide/dbt-cloud/read-artifact-from-an-environment.md
@@ -1,8 +1,8 @@
 # Read the latest artifacts from an environment
 
-This is a guideline on how to query the dbt cloud metadata given an environment by using [dbt CLoud Discovery API](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api). It's neither not requiring `JOB ID` nor `JOB RUN ID`, this is the dbt Cloud's `ENVIRONMENT ID`. Especially, with this method, `dbterd` doesn't require to download files before hands anymore, the ERD will be generated on fly 🚀.
+This is a guideline on how to query the dbt cloud metadata given an environment by using [dbt Cloud Discovery API](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api). It doesn't require `JOB ID` or `JOB RUN ID`, but rather the dbt Cloud's `ENVIRONMENT ID`. Especially, with this method, `dbterd` doesn't require downloading files beforehand anymore, the ERD will be generated on the fly 🚀.
 
-`dbterd` is now understanding GraphQL connection which is exposed by dbt CLoud Discovery API endpoint:
+`dbterd` now understands GraphQL connections which are exposed by dbt Cloud Discovery API endpoint:
 
 ```log
 https://metadata.YOUR_ACCESS_URL/graphql
@@ -15,7 +15,7 @@ https://metadata.YOUR_ACCESS_URL/graphql
     - You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/) 💰
     - Your projects must be on dbt version 1.0 or later 🏃
 
-The assumption is that you've already get the dbt Cloud project ready and is having at least 1 environment, and 1 job run successfully in this environment.
+The assumption is that you've already got the dbt Cloud project ready and have at least 1 environment, and 1 job run successfully in this environment.
 
 ## 1. Prepare the environment variables
 
@@ -68,13 +68,13 @@ $env:DBTERD_DBT_CLOUD_ENVIRONMENT_ID="your_value"
 
 We're going to use a new command as `dbterd run-metadata` to tell `dbterd` to use dbt Cloud Discovery API with all above variables.
 
-The command will be looks like:
+The command will look like:
 
 ```bash
 dbterd run-metadata [-s <dbterd selection>]
 ```
 
-> Behind the scenes, it will try use to the ERD GraphQL query built-in at [include/erd_query.gql](https://github.com/datnguye/dbterd/tree/main/dbterd/adapters/dbt_cloud/include/erd_query.gql)
+> Behind the scenes, it will try to use the ERD GraphQL query built-in at [include/erd_query.gql](https://github.com/datnguye/dbterd/tree/main/dbterd/adapters/dbt_cloud/include/erd_query.gql)
 
 and then, here is the sample console log:
 
diff --git a/docs/nav/guide/targets/generate-drawdb.md b/docs/nav/guide/targets/generate-drawdb.md
@@ -58,12 +58,12 @@ There we go, here is the sample output content:
 
 ## 3. Import to Draw DB Editor
 
-Go to the [Draw DB Editor](https://drawdb.vercel.app/editor) playaround:
+Go to the [Draw DB Editor](https://drawdb.vercel.app/editor) to play around:
 
 - Files > Import diagram
 - Choose the generated file e.g. `erd.ddb`
 - Click `Import`
 
-Voila 🎉, here the result:
+Voila 🎉, here's the result:
 
 ![import-ddb.png](./../../../assets/images/import-ddb.png)
diff --git a/docs/nav/guide/targets/generate-markdown-mermaid-erd.md b/docs/nav/guide/targets/generate-markdown-mermaid-erd.md
@@ -23,7 +23,7 @@
     <span data-ty data-ty-prompt="$ ~/repo>"></span>
 </div>
 
-### 3. Commit it and check it on Github
+### 3. Commit it and check it on GitHub
 
 Check out the [sample](https://github.com/datnguye/dbterd/blob/main/samples/dbtresto/ERD.md) output:
 
diff --git a/docs/nav/guide/targets/generate-plantuml.md b/docs/nav/guide/targets/generate-plantuml.md
@@ -14,15 +14,15 @@
 - Paste the PlantUML content generated as above
 - Wait for a second and get the URL
 
-### 3. Embedded the PlantUML URL into Markdown
+### 3. Embed the PlantUML URL into Markdown
 
 ```markdown
 ![](https://www.plantuml.com/plantuml/dpng/{your-hash})
 ```
 
 ![erd](https://www.plantuml.com/plantuml/dpng/fLRRZgCm37tlLw3vW4hbGgLzcZ-9N71tK251IPZPxhR_lh08gnjCZ3HzAPpZayknu_3kF5W_TEq1jM_yFNdhJ8tjiRvuPT5vSwoRJbtChxVapo4PV-EZkk4z-P5yWgq-m1BQr0nOWySHdlu8i-Y6rYizT1UqRcGrgRW8THf36kqts3JAPb4sZx95b2sZx9dOPzJPoPZ5skbvyfRyuZmax1xC_uLu2w3EQF_1OKf3XqosxWXsvy9xs_ocbVzx2Sg2y6KolMQChN7FX5Ue5cUNAUStzGdjW2zRD5KrM8kwua7L6wTEsrIwJMNRLBvD5TjKkKsTNwWMd5VGzmWMT4M545AqEIaWbG8oAI2N0Wefe9G2pXImhohKrLYimFcbF9Rt-V24it6dYXJKbwYKIITtBnhb5AOmtjT8bygwbDDbiYxZTBciopbT8UiAJbUAEWhPctjN6TledvJwaM9w4LSHiKuoZOhgj4BI5PAja7o552larGWB-aQdzzeQ2E2KXpCUpdcuuE6IOD7lEKtaCn34Vn4mA7zHy5UVDifSrPVHPDIYdrD5ooQyXwR-3swScXaFDzHxoyfXUDc8vpwyTuJM_JmamYNtV1oFZqVac-6G24cAZJ3kvri3pAxAGyYxU4TT3rtx5m00)
 
-## Known Limitation💡
+## Known Limitations💡
 
-- Plant UML connectors seem not to support to indicate the columns which are related to the Relationship
-- Left the question _"How to automate the markdown image URL generated?"_ opened
+- PlantUML connectors don't seem to support indicating the columns which are related to the Relationship
+- The question _"How to automate the markdown image URL generation?"_ remains open
diff --git a/docs/nav/metadata/relationship_type.md b/docs/nav/metadata/relationship_type.md
@@ -30,4 +30,4 @@ List of accepted values:
 | many-to-one | n1 |
 | Not specified/Invalid value | n1 |
 
-> NOTE: Known as we could configure multiple relationship types but in the best practice we should always have `many-to-one`
+> NOTE: We know that we could configure multiple relationship types but in best practice we should always have `many-to-one`
