diff --git a/source/import_documentation/faq.rst b/source/import_documentation/faq.rst new file mode 100644 index 0000000000000000000000000000000000000000..48ba69c5a898bcb122fe5632a5d5efcd1a30280b --- /dev/null +++ b/source/import_documentation/faq.rst @@ -0,0 +1,17 @@ +FAQ +**** + +* How to contribute ? + +First have a look to our guidelines + +* Where I can ask for help ? + +voir la partie aide de la docs de django project. +community + +* What is Solid ? + +* This is open source ? + + +Référencer cette faq partout \ No newline at end of file diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst index e3fead9e61ecce4dc0ab726a25505a3948877d0a..0958d88b2f614e903e2d549aa826b85df7ed73be 100644 --- a/source/import_documentation/get-started.rst +++ b/source/import_documentation/get-started.rst @@ -14,7 +14,7 @@ To start, simply import the core in your head tag of a simple html file : It enables you to use Startin’blox technology and all the main components from the core of the framework. -`Jump to the demonstration to go forward <sib-demo/>`__ +Jump to the `Demonstration`_ to go forward ! With the back ============= @@ -44,16 +44,18 @@ Since our frontend framework reads RDF, we adapted a Django server to handle lin That's it. You're almost ready to start :) -`Jump to the demonstration to go forward <sib-demo/>`__ - +Jump to the `Demonstration`_ to go forward ! Glossary -======== +============= -The glossary contains an overview of the most commonly used terms in the documentation. +To be sure to speak the same language throughout the documentation, +you’ll find any tricky vocabulary on this graphic glossary. -=> `Have a look on the glossary <Glossary/>`__ +.. figure:: ../_static/images/import_documentation/uploads/93e59fc5d2a1a8e2b1a87ec6428c9ca5/Glossaire-doc_1.jpg + :alt: Glossaire-doc_1 + Glossaire-doc_1 Something is missing ? ====================== diff --git a/source/import_documentation/what-is-sib.rst b/source/import_documentation/what-is-sib.rst index 45da9e3fa3ddaa319c29758b130a2024625c8379..d41b1048e7e30e887831e341650f010d857a7e9b 100644 --- a/source/import_documentation/what-is-sib.rst +++ b/source/import_documentation/what-is-sib.rst @@ -1,14 +1,20 @@ What is Startin'blox ? *********************** -Startin'blox is a front framework based on `Web Components <https://www.webcomponents.org/>`__ and `Linked Data conventions <https://www.w3.org/standards/semanticweb/data/>`__ to create interfaces compatible with the `SOLID specifications <https://github.com/solid/solid-spec/>`__. +Startin'blox is a front framework based on `Web Components <https://www.webcomponents.org/>`__ and `Linked Data conventions <https://www.w3.org/standards/semanticweb/data>`__ to create interfaces compatible with the `SOLID specifications <https://github.com/solid/solid-spec/>`__. Those tools are developed by the cooperative of the same name. - We are all, as users, captive to the digital platforms we use, attached to them by the network effect over which they have a monopoly. - Thanks to W3C and `the work of Tim Berners-Lee <https://solid.mit.edu//>`__, an alternative is possible. The new web standards allow the network effect to be shared between the different digital tools and give us back total control over our personal data. - - **Startin'blox has set itself the mission of precipitating the advent of this new type of digital platform.** +We are all, as users, captive to the digital platforms we use, attached to them by the network effect over which they have a monopoly. +Thanks to W3C and `the work of Tim Berners-Lee <https://solid.mit.edu//>`__, an alternative is possible. The new web standards allow the network effect to be shared between the different digital tools and give us back total control over our personal data. + +**Startin'blox has set itself the mission of precipitating the advent of this new type of digital platform.** + +To be sure to speak the same language throughout the documentation, +you’ll find any tricky vocabulary on this graphic glossary. + +.. figure:: ../_static/images/import_documentation/uploads/93e59fc5d2a1a8e2b1a87ec6428c9ca5/Glossaire-doc_1.jpg + :alt: Glossaire-doc_1 => To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__. diff --git a/source/index.rst b/source/index.rst index c638ca393ed25d966c7db79c02feae7e82071219..9bfca9a26fcf1e7e4b5de21ace78976c9a9a51bb 100644 --- a/source/index.rst +++ b/source/index.rst @@ -8,11 +8,8 @@ Welcome to Startinblox's documentation! import_documentation/what-is-sib import_documentation/why-use-sib import_documentation/get-started - import_documentation/faq - import_documentation/Glossary import_documentation/get-involved - import_documentation/Contribution-guidelines - + .. toctree:: :maxdepth: 2 :caption: How it work: @@ -23,14 +20,14 @@ Welcome to Startinblox's documentation! import_documentation/widgets import_documentation/server-packages -.. toctree:: - :maxdepth: 2 - :caption: Advanced features: +.. .. toctree:: +.. :maxdepth: 2 +.. :caption: Advanced features: - import_documentation/List-Post-processing - import_documentation/Events - import_documentation/Helpers-functions - import_documentation/Mixin-API +.. import_documentation/List-Post-processing +.. import_documentation/Events +.. import_documentation/Helpers-functions +.. import_documentation/Mixin-API .. toctree:: :maxdepth: 2