Add images to documentation

david-yz-liu · Oct 19, 2024 · 9f4acea · 9f4acea
1 parent 5ef7cf3
commit 9f4acea
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/docs/docs/99-api/images/jest-svg-viewer-file-select.png b/docs/docs/99-api/images/jest-svg-viewer-file-select.png
diff --git a/docs/docs/99-api/images/jest-svg-viewer.png b/docs/docs/99-api/images/jest-svg-viewer.png
diff --git a/memory-viz/README.md b/memory-viz/README.md
@@ -113,3 +113,11 @@ To run the test suite, execute the following command:
 ```console
 $ npm run test --workspace=memory-viz
 ```
+
+#### Viewing Jest SVG snapshots
+
+To easily view the Jest SVG snapshots, run `open memory-viz/src/tests/__snapshots__/snapshot.html` and select the snapshot outputs with the `*.snap` extension:
+
+![Jest SVG Viewer File Select](../docs/docs/99-api/images/jest-svg-viewer-file-select.png)
+
+![Jest SVG Viewer](../docs/docs/99-api/images/jest-svg-viewer.png)