update vignette

biocypher · Aug 2, 2024 · a9d51f9 · a9d51f9
1 parent 6e1010a
commit a9d51f9
Show file tree

Hide file tree

Showing 12 changed files with 16 additions and 0 deletions.
diff --git a/docs/images/boxplot-naive-vs-biochatter.pdf b/docs/images/boxplot-naive-vs-biochatter.pdf
diff --git a/docs/images/dotplot-per-task.pdf b/docs/images/dotplot-per-task.pdf
diff --git a/docs/images/dotplot-per-task.png b/docs/images/dotplot-per-task.png
diff --git a/docs/images/scatter-per-quantisation-name.pdf b/docs/images/scatter-per-quantisation-name.pdf
diff --git a/docs/images/scatter-per-quantisation-name.png b/docs/images/scatter-per-quantisation-name.png
diff --git a/docs/images/scatter-quantisation-accuracy.pdf b/docs/images/scatter-quantisation-accuracy.pdf
diff --git a/docs/images/scatter-size-accuracy.pdf b/docs/images/scatter-size-accuracy.pdf
diff --git a/docs/images/stripplot-extraction-tasks.png b/docs/images/stripplot-extraction-tasks.png
diff --git a/docs/images/stripplot-per-model.png b/docs/images/stripplot-per-model.png
diff --git a/docs/images/stripplot-rag-tasks.pdf b/docs/images/stripplot-rag-tasks.pdf
diff --git a/docs/images/stripplot-rag-tasks.png b/docs/images/stripplot-rag-tasks.png
diff --git a/docs/vignette-custom-bclight-advanced.md b/docs/vignette-custom-bclight-advanced.md
@@ -42,6 +42,22 @@ Project board. The pre-existing KG build and deploy scripts were used via the
 `docker-compose-password.yml`, which builds a password-protected version of the
 KG. Deployment and setup of the cloud VM took another ~2h.
 
+The schema of the knowledge graph is as follows:
+
+```mermaid
+graph LR;
+    Person -- Leads --> Project
+    Project -- PartOf --> Iteration
+    Project -- HasComment --> Comment
+```
+
+Other available fields include `Title`, `Assignees`, `Status`, `Labels`,
+`Linked pull requests`, `Milestone`, `Repository`, `Reviewers`, `Priority`,
+`Size`, `Estimate`, `Iteration`, `Start date`, and `End date`. Some of these,
+such as `Priority` and `Size`, are properties of the project item in our current
+implementation. These assignments, including the schmema of the graph, can be
+flexibly adapted by using BioCypher mechanisms.
+
 Be aware that running this script will require a GitHub token with access to the
 project board. This token should be stored in the environment variable
 `BIOCYPHER_GITHUB_PROJECT_TOKEN`.