Merge pull request #5 from OpenDataServices/2024-10-10

docs: Add diagram to explain library and app dependencies
OpenDataServices · Oct 10, 2024 · c16b85f · c16b85f
2 parents ea2df8d + d1e45ac
commit c16b85f
Show file tree

Hide file tree

Showing 2 changed files with 214 additions and 2 deletions.
diff --git a/docs/_images/library-app-dependencies.svg b/docs/_images/library-app-dependencies.svg
diff --git a/docs/used-by.rst b/docs/used-by.rst
@@ -1,13 +1,19 @@
 Used by
 =======
 
-This library is directly used by:
+This diagram explains how this library is used to eventually support CoVE web apps:
+
+.. image:: _images/library-app-dependencies.svg
+   :target: _images/library-app-dependencies.svg
+
+
+This library is directly used by these standard specific libraries:
 
 * https://github.com/openownership/lib-cove-bods
 * https://github.com/Open-Telecoms-Data/lib-cove-ofds
 * https://github.com/GFDRR/rdls-lib-cove
 
-Those libraries are in turn used for these CoVE web apps:
+Those standard specific libraries are in turn used for these standard specific CoVE web apps:
 
 * https://github.com/openownership/cove-bods
 * https://github.com/Open-Telecoms-Data/cove-ofds