checklist page, fix image links

DataRecce · Jan 31, 2024 · c29fb11 · c29fb11
1 parent 7dbdeea
commit c29fb11
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/docs/assets/images/features/checklist.png b/docs/assets/images/features/checklist.png
diff --git a/docs/docs/demo.md b/docs/docs/demo.md
@@ -12,7 +12,7 @@ Try `Recce` without installing using this [online demo](https://pr1.cloud.datare
 The demo showcases a [pull request](https://github.com/DataRecce/jaffle_shop_duckdb/pull/1) that fixes the `customer_lifetime_value` calculation in dbt's Jaffle Shop project to only included completed orders.
 
 <figure markdown>
-  ![customers.sql](../../assets/images/demo/clv-customers-model-fs8.png)
+  ![customers.sql](../assets/images/demo/clv-customers-model-fs8.png)
   <figcaption>Jaffle Shop customers.sql</figcaption>
 </figure>
 
@@ -26,7 +26,7 @@ Some example validation checks you might create include:
 Run a [Value Diff](features/value-diff.md) to check the percentage match of the `customer_lifetime_value` column between production and the development branch.
 
 <figure markdown>
-  ![CLV Value Diff](../../assets/images/demo/clv-value-diff-fs8.png)
+  ![CLV Value Diff](../assets/images/demo/clv-value-diff-fs8.png)
   <figcaption>Value Diff - Customers Model</figcaption>
 </figure>
 
@@ -35,7 +35,7 @@ Run a [Value Diff](features/value-diff.md) to check the percentage match of the
 Check the [Profile Diff](features/profile-diff.md) of the customers table to see how the `customer_lifetime_value` has been impacted.
 
 <figure markdown>
-  ![CLV Profile Diff](../../assets/images/demo/clv-profile-diff-fs8.png)
+  ![CLV Profile Diff](../assets/images/demo/clv-profile-diff-fs8.png)
   <figcaption>Profile Diff - Customers Model</figcaption>
 </figure>
 
@@ -48,7 +48,7 @@ select customer_id, customer_lifetime_value from {{ ref("customers") }} where cu
 ```
 
 <figure markdown>
-  ![CLV Query Diff](../../assets/images/demo/clv-query-diff-fs8.png)
+  ![CLV Query Diff](../assets/images/demo/clv-query-diff-fs8.png)
   <figcaption>Query Diff - Customers Model</figcaption>
 </figure>
 

diff --git a/docs/docs/features/checklist.md b/docs/docs/features/checklist.md
@@ -2,4 +2,13 @@
 title: Checklist
 ---
 
-# Checklist
+# Checklist
+
+Save your validation checks to the Recce checklist with a description of your findings.
+
+These checks can later be added to your pull request comment as proof-of-correctness for your modeling changes.
+
+<figure markdown>
+  ![Recce Checklist](../../assets/images/features/checklist.png)
+  <figcaption>Checklist</figcaption>
+</figure>
diff --git a/docs/docs/features/query-diff.md b/docs/docs/features/query-diff.md
@@ -13,14 +13,14 @@ select * from {{ ref("mymodel") }}
 ```
 
 <figure markdown>
-  ![Recce Query Diff](../../../assets/images/features/query-diff.png)
+  ![Recce Query Diff](../../assets/images/features/query-diff.png)
   <figcaption>Query Diff</figcaption>
 </figure>
 
 After performing a query, select the primary key by clicking the `key` icon.
 
 <figure markdown>
-  ![Recce Query Diff](/../assets/images/features/query-diff.gif)
+  ![Recce Query Diff](../../assets/images/features/query-diff.gif)
   <figcaption>Query Diff</figcaption>
 </figure>