From edd6f903f23dc2d00dadca6ac79d160366cb57fc Mon Sep 17 00:00:00 2001
From: Dat Nguyen <dat@infinitelambda>
Date: Mon, 10 Apr 2023 09:10:03 +0700
Subject: [PATCH] Update docs [skip ci]

---
 README.md  | 14 +++++++++-----
 mkdocs.yml |  6 +++---
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 94e5b65..cd3a15c 100755
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ The purpose of the dq tool is to make simple storing test results and visualisat
 ![dwh](https://img.shields.io/badge/DWH-BigQuery-green?logo=google&logoColor=white)
 
 **Installation**:
+
 - Add to `packages.yml` file:
   ```yml
   packages:
@@ -31,7 +32,7 @@ The purpose of the dq tool is to make simple storing test results and visualisat
 - Add on-run-start hook:
   ```yml
   on-run-start:
-    - '{{ dq_tools.create_table_dq_issue_log() }}'
+    - '{{ dq_tools.create_dq_issue_log() }}'
   ```
 
 - Add on-run-end hook:
@@ -51,6 +52,7 @@ The idea behind the layer is that each layer can be changed, extended or replace
 
 ## Data Quality KPIs
 There are 6 main KPIs will be produced as below:
+
 - Accuracy
 - Consistency
 - Completeness
@@ -58,7 +60,7 @@ There are 6 main KPIs will be produced as below:
 - Validity
 - Uniqueness
 
-![DataQualityKPIs](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/DataQualityKPIs.png)
+![DataQualityKPIs](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/DataQualityKPIs.png)
 
 NOTE: It is possible that we can have custom KPI(s) as you go but it is NOT recommended as the existing modelling design will stick to the above 6 ones only.
 ```yaml
@@ -101,10 +103,10 @@ models:
 
 - STEP 3 - run the dbt test and check:
   Test results in the dq issue log table:
-  ![TestResultLog](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/TestResultLog.png)
+  ![TestResultLog](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/TestResultLog.png)
 
   Data quality KPIs in looker:
-  ![LookerDashboard](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/LookerDashboard.png)
+  ![LookerDashboard](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/LookerDashboard.png)
 
 
 ## Installation Instructions
@@ -434,4 +436,6 @@ models:
 ```
 
 ## Contributing
-If you've ever wanted to contribute to this tool, and a great cause, feel free to create your [Pull Request](https://github.com/infinitelambda/dq-tools/pulls), or submit a new issue via [Bug Report](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=bug_report.md&title=[BUG]%20Describe%20it%20shortly) / [Feature Request](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=feature_request.md&title=[FEATURE]%20Describe%20it%20shortly) 💖
\ No newline at end of file
+If you've ever wanted to contribute to this tool, and a great cause, feel free to create your [Pull Request](https://github.com/infinitelambda/dq-tools/pulls), or submit a new issue via [Bug Report](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=bug_report.md&title=[BUG]%20Describe%20it%20shortly) / [Feature Request](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=feature_request.md&title=[FEATURE]%20Describe%20it%20shortly) 💖
+
+For more details, please help to check [Contributing](https://infinitelambda.github.io/dq-tools/nav/development/contributing-guide.html) documentation!
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 7b8b163..e6c90d6 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: Data Quality Tool
+site_name: Data Quality Tools
 site_url: https://infinitelambda.github.io/dq-tools/
 site_author: Infinite Lambda
 site_description: Offical documentation of `dq-tools` dbt package
@@ -64,8 +64,8 @@ plugins:
         on_post_build: "docs.hooks:copy_dbt_docs"
 
 nav:
-  - ✨dq-tools: index.md
-  - 👉dbt docs: dbt-docs/index.html # managed by hooks.copy_dbt_docs
+  - ✨ dq-tools: index.md
+  - 👉 dbt docs: dbt-docs/index.html # managed by hooks.copy_dbt_docs
   - Development:
     - nav/development/contributing-guide.md
     - nav/development/release-notes.md