Add terminology diagram to documentation (#126)

devsisters · May 2, 2024 · 91713e8 · 91713e8
1 parent 3340e84
commit 91713e8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/vuepress/docs/.vuepress/public/terminology.png b/vuepress/docs/.vuepress/public/terminology.png
diff --git a/vuepress/docs/docs/README.md b/vuepress/docs/docs/README.md
@@ -54,6 +54,8 @@ Entities usually run on multiple pods, but a single entity will only run on a si
 - A **shard** is a logical group of entities that will always be located on the same pod.
 There might be millions of entities, so instead of keeping millions of entities-to-pods mappings, we group entities into shards and maintain reasonably-sized shards-to-pods mappings.
 
+![terminology diagram](/shardcake/terminology.png)
+
 ## Key components
 
 Shardcake is composed of 2 main components: