diff --git a/source/_static/images/import_documentation/core-architecture.png b/source/_static/images/import_documentation/core-architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..8c2503db5d45265b78dc8bcd2b85af3a09adca93 Binary files /dev/null and b/source/_static/images/import_documentation/core-architecture.png differ diff --git a/source/_static/images/import_documentation/list-post-processing.png b/source/_static/images/import_documentation/list-post-processing.png new file mode 100644 index 0000000000000000000000000000000000000000..49389b992c12d35fd8746b36da36e1915a66619d Binary files /dev/null and b/source/_static/images/import_documentation/list-post-processing.png differ diff --git a/source/_static/images/import_documentation/sib-api.png b/source/_static/images/import_documentation/sib-api.png new file mode 100644 index 0000000000000000000000000000000000000000..b535dea5e88c379c0de44dca137ee0f60a20a203 Binary files /dev/null and b/source/_static/images/import_documentation/sib-api.png differ diff --git a/source/import_documentation/core-framework-architecture.rst b/source/import_documentation/core-framework-architecture.rst new file mode 100644 index 0000000000000000000000000000000000000000..561e6a2a9f55295750ce70c891d1995253576e3a --- /dev/null +++ b/source/import_documentation/core-framework-architecture.rst @@ -0,0 +1,25 @@ +Framework Architecture +################### + +Mixin API +========= +Here is a simplified schema of how the API works to create a component: + +.. figure:: ../_static/images/import_documentation/sib-api + :alt: + +Core Architecture +================ + +Here is a simplified schema of the organization and the responsibilities of the classes of the core: + +.. figure:: ../_static/images/import_documentation/core-architecture + :alt: The Core architecture + +List post-processing +=================== + +A sib-display component is capable of showing a list of resources and applying different filters on this list to filter, sort, group... resources. Here is a schema of the order of these transformations: + +.. figure:: ../_static/images/import_documentation/list-post-processing + :alt: List post-processing \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 610be2e77a570a3af458f954d8663132af441300..37ae433f0d5351924439d4f556b0429b279a0b41 100644 --- a/source/index.rst +++ b/source/index.rst @@ -19,6 +19,7 @@ Welcome to Startinblox's documentation! import_documentation/sib-demo import_documentation/server-architecture + import_documentation/core-framework-architecture import_documentation/web-component import_documentation/widgets import_documentation/server-packages