Skip to content
Snippets Groups Projects
Commit 7386e879 authored by Manon Bourgognon's avatar Manon Bourgognon
Browse files

update: modications on documentation

parent 61603803
No related branches found
No related tags found
1 merge request!78update: documentation's modifications
Showing
with 57 additions and 149 deletions
Welcome to Startinblox's documentation
========================================
.. toctree::
:maxdepth: 2
:caption: First Step
import_documentation/first_step/sib-presentation
import_documentation/first_step/get-started
import_documentation/first_step/Solid-introduction
import_documentation/first_step/faq
.. toctree::
:maxdepth: 2
:caption: DjangoLDP Guide
import_documentation/djangoldp_guide/install-djangoldp-server
import_documentation/djangoldp_guide/djangoldp-references
import_documentation/djangoldp_guide/server-architecture
.. toctree::
:maxdepth: 2
:caption: Framework Guide
import_documentation/framework_guide/how-to-use-the-documentation
import_documentation/framework_guide/list-base-components
import_documentation/framework_guide/list-external-components
import_documentation/framework_guide/list-mixins
import_documentation/framework_guide/attributes-list
import_documentation/framework_guide/list-widgets
import_documentation/framework_guide/javascript-API
.. toctree::
:maxdepth: 2
:caption: About
import_documentation/about/About-our-components
import_documentation/about/About-semantic-web
import_documentation/about/About-activity-pub
import_documentation/about/About-authentification-sso
import_documentation/about/About-the-cooperative
.. toctree::
:maxdepth: 2
:caption: Frequent Errors
import_documentation/frequent_errors/frequent-errors
.. _sib-auth:
sib-auth
================
========
Allows your users to login via a given OIDC provider.
......
......@@ -21,7 +21,7 @@ The new web standards allow the network effect to be shared between the differen
We've built a solution to make the creation of federated and interoperable applications as accessible as possible.
.. figure:: ../_static/images/import_documentation/federation.png
.. figure:: ../../_static/images/import_documentation/federation.png
:alt: Federation concept
=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__.
......@@ -50,7 +50,7 @@ Startin'blox creates components according to its uses but in the future we encou
For example, Sib-Directory provides you with a user directory that includes user skills.
.. figure:: ../_static/images/import_documentation/Components.png
.. figure:: ../../_static/images/import_documentation/Components.png
:alt: Component example
Each component treats a specific shape of data. The validation of this shape is made on the server side.
......@@ -63,7 +63,7 @@ the Linked datas platform conventions, named DjangoLDP.
It is a simple architecture on which we can add LDP packages, corresponding to the different components used.
Those are the ones that will do the work of validating the application data.
.. figure:: ../_static/images/import_documentation/Overview-server.png
.. figure:: ../../_static/images/import_documentation/Overview-server.png
:alt: Server overview
.. note::
......@@ -72,7 +72,7 @@ Those are the ones that will do the work of validating the application data.
The solution can be summarized as follows:
.. figure:: ../_static/images/import_documentation/Overview-of-SiB.png
.. figure:: ../../_static/images/import_documentation/Overview-of-SiB.png
:alt: SiB overview
......@@ -85,7 +85,7 @@ Overview of the Framework
Here is a brief presentation:
.. figure:: ../_static/images/import_documentation/Framework-Overview.png
.. figure:: ../../_static/images/import_documentation/Framework-Overview.png
:alt: Framework Overview
`To go deeper <https://git.happy-dev.fr/startinblox/framework/sib-core/>`__.
......@@ -132,7 +132,7 @@ components <https://en.wikipedia.org/wiki/Web_Components>`__ that can
receive federated data sources in RDF. This means that you can only use
a component using data sources already available on the web.
.. figure:: ../_static/images/import_documentation/federation.png
.. figure:: ../../_static/images/import_documentation/federation.png
:alt: Federation
......
......@@ -6,6 +6,6 @@ This section presents how you can use Javascript API with sib-core.
.. toctree::
:maxdepth: 1
import_documentation/javascript_API/Events
import_documentation/javascript_API/Helpers-functions
import_documentation/javascript_API/Store-doc
\ No newline at end of file
:ref:`Events <events>`
:ref:`Javascript Helpers <javascript-helpers>`
:ref:`Store documentation <store-documentation>`
\ No newline at end of file
......@@ -9,13 +9,13 @@ The base components are :
.. toctree::
:maxdepth: 1
import_documentation/Components/Solid-Ac-Checker
import_documentation/Components/Solid-Calendar
import_documentation/Components/Solid-Display
import_documentation/Components/Solid-Delete
import_documentation/Components/Solid-Form
import_documentation/Components/Solid-Form-Search
import_documentation/Components/Solid-Lang
import_documentation/Components/Solid-Map
import_documentation/Components/Solid-Table
import_documentation/Components/Solid-Widget
\ No newline at end of file
:ref:`solid-ac-checker <solid-ac-checker>`
:ref:`solid-calendar <solid-calendar>`
:ref:`solid-display <solid-display>`
:ref:`solid-delete <solid-delete>`
:ref:`solid-form <solid-form>`
:ref:`solid-form-search <solid-form-search>`
:ref:`solid-lang <solid-lang>`
:ref:`solid-map <solid-map>`
:ref:`solid-table <solid-table>`
:ref:`solid-widget <solid-widget>`
\ No newline at end of file
......@@ -7,5 +7,5 @@ however they can be used to add useful features such as authentication and route
.. toctree::
:maxdepth: 1
import_documentation/Components/Solid-Auth
import_documentation/Components/Solid-Router
:ref:`solid-auth <sib-auth>`
:ref:`solid-router <solid-router>`
......@@ -7,16 +7,16 @@ the base components to best render the content of the application :
.. toctree::
:maxdepth: 1
import_documentation/Mixins/counter-mixin
import_documentation/Mixins/federation-mixin
import_documentation/Mixins/filter-mixin
import_documentation/Mixins/grouper-mixin
import_documentation/Mixins/highlighter-mixin
import_documentation/Mixins/list-mixin
import_documentation/Mixins/next-mixin
import_documentation/Mixins/paginate-mixin
import_documentation/Mixins/required-mixin
import_documentation/Mixins/sorter-mixin
import_documentation/Mixins/store-mixin
import_documentation/Mixins/validation-mixin
import_documentation/Mixins/widget-mixin
:ref:`counter-mixin <counter-mixin>`
:ref:`federation-mixin <federation-mixin>`
:ref:`filter-mixin <filter-mixin>`
:ref:`grouper-mixin <grouper-mixin>`
:ref:`highlighter-mixin <highlighter-mixin>`
:ref:`list-mixin <list-mixin>`
:ref:`next-mixin <next-mixin>`
:ref:`paginate-mixin <paginate-mixin>`
:ref:`required-mixin <required-mixin>`
:ref:`sorter-mixin <sorter-mixin>`
:ref:`store-mixin <store-mixin>`
:ref:`validation-mixin <validation-mixin>`
:ref:`widget-mixin <widget-mixin>`
......@@ -7,5 +7,5 @@ How to create them and how to use them are precised :
.. toctree::
:maxdepth: 1
import_documentation/Widgets/Reference
import_documentation/Widgets/Examples
\ No newline at end of file
:ref:`Widget API Reference <reference>`
:ref:`Examples <examples>`
\ No newline at end of file
.. _events:
Events
------
======
Our objective is to use the minimum of javascript.
......@@ -28,7 +30,7 @@ But for now, here are some events that will be useful to you.
+------+---------+------------------------+---------------------------+
Examples
~~~~~~~~
--------
``populate``
^^^^^^^^^^^^
......
.. _javascript-helpers:
Javascript Helpers
=====================
==================
Helpers fonctions
-----------------
......
.. _store-documentation:
Store documentation
====================
......
......@@ -6,8 +6,8 @@ Welcome to Startinblox's documentation
:caption: First Step
import_documentation/first_step/sib-presentation
import_documentation/first_step/Solid-introduction
import_documentation/first_step/get-started
import_documentation/first_step/Solid-introduction
import_documentation/first_step/faq
.. toctree::
......@@ -18,81 +18,31 @@ Welcome to Startinblox's documentation
import_documentation/djangoldp_guide/djangoldp-references
import_documentation/djangoldp_guide/server-architecture
.. toctree::
:maxdepth: 2
:caption: Get started with sib-core
:caption: Framework Guide
import_documentation/framework_guide/how-to-use-the-documentation
import_documentation/framework_guide/list-base-components
import_documentation/framework_guide/list-external-components
import_documentation/framework_guide/list-mixins
import_documentation/framework_guide/attributes-list
import_documentation/framework_guide/list-widgets
import_documentation/framework_guide/javascript-API
.. toctree::
:maxdepth: 2
:caption: Base components
import_documentation/Components/Solid-Display
import_documentation/Components/Solid-Form
import_documentation/Components/Solid-Form-Search
import_documentation/Components/Solid-Delete
import_documentation/Components/Solid-Calendar
import_documentation/Components/Solid-Map
import_documentation/Components/Solid-Ac-Checker
import_documentation/Components/Solid-Widget
import_documentation/Components/Solid-Lang
import_documentation/Components/Solid-Table
.. toctree::
:maxdepth: 2
:caption: External components
import_documentation/Components/Solid-Auth
import_documentation/Components/Solid-Router
.. toctree::
:maxdepth: 2
:caption: Mixins
import_documentation/Mixins/store-mixin
import_documentation/Mixins/widget-mixin
import_documentation/Mixins/list-mixin
import_documentation/Mixins/counter-mixin
import_documentation/Mixins/federation-mixin
import_documentation/Mixins/grouper-mixin
import_documentation/Mixins/filter-mixin
import_documentation/Mixins/paginate-mixin
import_documentation/Mixins/sorter-mixin
import_documentation/Mixins/highlighter-mixin
import_documentation/Mixins/required-mixin
import_documentation/Mixins/next-mixin
import_documentation/Mixins/validation-mixin
.. toctree::
:maxdepth: 2
:caption: Widgets
import_documentation/Widgets/Reference
import_documentation/Widgets/Examples
.. toctree::
:maxdepth: 2
:caption: Javascript API
import_documentation/javascript_API/Events
import_documentation/javascript_API/Helpers-functions
import_documentation/javascript_API/Store-doc
.. toctree::
:maxdepth: 2
:caption: About
import_documentation/about/About-our-components
import_documentation/about/About-semantic-web
import_documentation/about/About-activity-pub
import_documentation/about/About-authentication-sso
import_documentation/about/About-authentification-sso
import_documentation/about/About-the-cooperative
.. toctree::
.. toctree::
:maxdepth: 2
:caption: Frequent Errors
import_documentation/frequent_errors/frequent-errors
import_documentation/frequent_errors/frequent-errors
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment