From d1e45ac5a548df46caa394c472f7288db00fb8c0 Mon Sep 17 00:00:00 2001 From: James B Date: Thu, 10 Oct 2024 09:46:32 +0100 Subject: [PATCH] docs: Add diagram to explain library and app dependencies --- docs/_images/library-app-dependencies.svg | 206 ++++++++++++++++++++++ docs/used-by.rst | 10 +- 2 files changed, 214 insertions(+), 2 deletions(-) create mode 100644 docs/_images/library-app-dependencies.svg diff --git a/docs/_images/library-app-dependencies.svg b/docs/_images/library-app-dependencies.svg new file mode 100644 index 0000000..1ac3b18 --- /dev/null +++ b/docs/_images/library-app-dependencies.svg @@ -0,0 +1,206 @@ + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + Standard specific cove app eg cove-bods + lib-cove-2 + Standard specific library eg lib-cove-bods + lib-cove-web-2 + + + + + + + + + + diff --git a/docs/used-by.rst b/docs/used-by.rst index 080d562..1355431 100644 --- 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