[docs] Added architecture diagram

[skip ci]
openwisp · Jul 26, 2024 · d949168 · d949168
1 parent ae8d8df
commit d949168
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 10 deletions.
diff --git a/docs/images/architecture-v2-openwisp-users.png b/docs/images/architecture-v2-openwisp-users.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,37 @@
 Users
 =====
 
-**Source code**: `github.com/openwisp/openwisp-users
-<https://github.com/openwisp/openwisp-users>`_.
+.. seealso::
 
-The OpenWISP Users module leverages the capabilities of the `Django
-Framework <https://djangoproject.com/>`_ and its rich ecosystem to provide
-OpenWISP with features for managing user accounts, permission groups,
-supporting different authentication schemes, implementing multi-tenancy
-for allowing multiple organizations to be managed by different users
-within a single OpenWISP instance and more.
+    **Source code**: `github.com/openwisp/openwisp-users
+    <https://github.com/openwisp/openwisp-users>`_.
+
+The OpenWISP Users module leverages the capabilities of the `Django Framework
+<https://djangoproject.com/>`_ and its rich ecosystem to provide OpenWISP with features
+for managing user accounts, permission groups, supporting different authentication
+schemes, implementing multi-tenancy for allowing multiple organizations to be managed by
+different users within a single OpenWISP instance and more.
 
 For a full introduction please refer to :doc:`user/intro`.
 
+The following diagram illustrates the role of the Users module within the OpenWISP
+architecture.
+
+.. figure:: images/architecture-v2-openwisp-users.png
+    :target: ../_images/architecture-v2-openwisp-users.png
+    :align: center
+    :alt: OpenWISP Architecture: Users module
+
+    **OpenWISP Architecture: highlighted users module**
+
+.. important::
+
+    For an enhanced viewing experience, open the image above in a new browser tab.
+
+    Refer to :doc:`/general/architecture` for more information.
+
 .. toctree::
-    :caption: Usage Docs
+    :caption: Users Module Usage Docs
     :maxdepth: 1
 
     user/intro.rst
@@ -24,7 +41,7 @@ For a full introduction please refer to :doc:`user/intro`.
     user/rest-api.rst
 
 .. toctree::
-    :caption: Developer Docs
+    :caption: Users Module Developer Docs
     :maxdepth: 2
 
     Developer Docs Index <developer/index.rst>