From d3a35fd3647c7b28c128a0ffe2cd38c6e0e1b7b1 Mon Sep 17 00:00:00 2001
From: EdmundGoodman <egoodman3141@gmail.com>
Date: Mon, 29 Apr 2024 21:59:23 +0100
Subject: [PATCH] Update YAML schema documentation page

---
 docs/yaml_schema.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/docs/yaml_schema.md b/docs/yaml_schema.md
index f5ea5ba..8605492 100644
--- a/docs/yaml_schema.md
+++ b/docs/yaml_schema.md
@@ -5,12 +5,19 @@ hide:
 
 # YAML Schema
 
+The YAML schema is the key abstraction which allows similar workflows for
+performance analysis to be captured by this single tool.
+
+Pydantic is used to parse the YAML file, and as such a full description of the
+YAML schema can be seen in the entity-relationship diagram of the Pydantic
+model, shown below.
+
 <figure markdown="span">
-  ![Viewing run configurations](./assets/images/uml/yaml_model){ loading=lazy }
+  ![Viewing run configurations](./assets/images/uml/yaml_model.png){ loading=lazy }
   <figcaption>A diagram of the Pydantic model used to parse the YAML schema, generated using erdantic.</figcaption>
 </figure>
 
-## Run Configurations
+<!-- ## Run Configurations
 
 ## Test Benches
 
@@ -22,4 +29,4 @@ hide:
 
 #### Metrics
 
-#### Plotting
+#### Plotting -->