From e712a0d1c8448402d7de06a94b714e8a04a66714 Mon Sep 17 00:00:00 2001 From: Alice <alice.poggioli@hotmail.fr> Date: Tue, 14 Apr 2020 16:26:38 +0200 Subject: [PATCH] update --- .../Components/community-components.rst | 14 ----- .../Components/framework-components.rst | 15 ----- .../Components/official-components.rst | 8 --- source/import_documentation/get-started.rst | 62 ------------------- source/import_documentation/sib-demo.rst | 25 ++++++++ source/import_documentation/what-is-sib.rst | 9 +++ source/import_documentation/why-use-sib.rst | 17 +++++ source/index.rst | 15 ++--- 8 files changed, 56 insertions(+), 109 deletions(-) delete mode 100644 source/import_documentation/Components/community-components.rst delete mode 100644 source/import_documentation/Components/framework-components.rst delete mode 100644 source/import_documentation/Components/official-components.rst create mode 100644 source/import_documentation/sib-demo.rst create mode 100644 source/import_documentation/what-is-sib.rst create mode 100644 source/import_documentation/why-use-sib.rst diff --git a/source/import_documentation/Components/community-components.rst b/source/import_documentation/Components/community-components.rst deleted file mode 100644 index c59e270..0000000 --- a/source/import_documentation/Components/community-components.rst +++ /dev/null @@ -1,14 +0,0 @@ -The community components -************************* - -.. toctree:: - :maxdepth: 2 - :caption: Components: - - SiB-Ac-Checker - Sib-Calendar - SiB-Delete - SiB-Display - SiB-Form - SiB-Map - SiB-Widget diff --git a/source/import_documentation/Components/framework-components.rst b/source/import_documentation/Components/framework-components.rst deleted file mode 100644 index 2df5ccd..0000000 --- a/source/import_documentation/Components/framework-components.rst +++ /dev/null @@ -1,15 +0,0 @@ -The framework components -************************* - -.. toctree:: - :maxdepth: 2 - :caption: Components: - - SiB-Ac-Checker - Sib-Calendar - SiB-Delete - SiB-Display - SiB-Form - SiB-Map - SiB-Widget - diff --git a/source/import_documentation/Components/official-components.rst b/source/import_documentation/Components/official-components.rst deleted file mode 100644 index 644b69d..0000000 --- a/source/import_documentation/Components/official-components.rst +++ /dev/null @@ -1,8 +0,0 @@ -The official components -************************* - -.. toctree:: - :maxdepth: 2 - :caption: Components: - - diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst index ca4e99c..15e22af 100644 --- a/source/import_documentation/get-started.rst +++ b/source/import_documentation/get-started.rst @@ -1,72 +1,10 @@ -First Steps -########### - -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/>`__. - -=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__. - -.. notice:: - But not only. To improve. - -Why use Startin'blox ? -*********************** -.. warning:: - Give theroric exemple and use case. Graphic part.bling - - Getting Started **************** .. warning:: Use Sib pour faire le font et Djangoldp pour le back -Hello Word -========== - -The simplest code you can try with SiB look like this : - -.. code:: html - - <sib-display data-src="https://api.startinblox.com/helloworlds/" fields="helloword"></sib-display - -sib-display is one of the main component of the framework that display fields of a data source. -Our data sources are formatted with JsonLD. - -=> `Why JsonLD ? <Solid-introduction/>`__ - -Have a look on how our datas are structured : `https://api.startinblox.com/helloworlds/ <https://api.startinblox.com/helloworlds/>`__ - - -Play with Startin'blox ----------------------- - -To try the framework, you can play with -=> `our demo <https://startinblox.com/fr/technology#demo/>`__. - - -Use Startin'blox -=============== - -Startin'blox was designed to be modular. You can integrate only one component to an existing application or build an entire application in SiB. You are not supposed to master javascript to use the framework but as we are still in development, it is advisable to have some notions - - - -Add a SiB components to a website ----------------------------------- - -You can easily and quickly add a component to an existing application juste adding a script and a tag. We are currently working on making integration even easier with WordPress plugins. - -=> `How to integrate a component ? <Use-a-component-alone-in-an-existing-application/>`__ - - -Create an application with SiB ------------------------------- -You'll find in the framework everything you need to build an entiere application. To start a project in SiB, you just need a simple HTML file, add framework scripts and put tags. -=> `How to build a full application ? <build-full-application/>`__ Glossary -------- diff --git a/source/import_documentation/sib-demo.rst b/source/import_documentation/sib-demo.rst new file mode 100644 index 0000000..4140d41 --- /dev/null +++ b/source/import_documentation/sib-demo.rst @@ -0,0 +1,25 @@ +Demonstration +############# + +Hello Word +========== + +The simplest code you can try with SiB look like this : + +.. code:: html + + <sib-display data-src="https://api.startinblox.com/helloworlds/" fields="helloword"></sib-display + +sib-display is one of the main component of the framework that display fields of a data source. +Our data sources are formatted with JsonLD. + +=> `Why JsonLD ? <Solid-introduction/>`__ + +Have a look on how our datas are structured : `https://api.startinblox.com/helloworlds/ <https://api.startinblox.com/helloworlds/>`__ + + +Play with Startin'blox +======================= + +To try the framework, you can play with +=> `our demo <https://startinblox.com/fr/technology#demo/>`__. diff --git a/source/import_documentation/what-is-sib.rst b/source/import_documentation/what-is-sib.rst new file mode 100644 index 0000000..b678ee1 --- /dev/null +++ b/source/import_documentation/what-is-sib.rst @@ -0,0 +1,9 @@ +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/>`__. + +=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__. + +.. notice:: + But not only. To improve. \ No newline at end of file diff --git a/source/import_documentation/why-use-sib.rst b/source/import_documentation/why-use-sib.rst new file mode 100644 index 0000000..35d3a60 --- /dev/null +++ b/source/import_documentation/why-use-sib.rst @@ -0,0 +1,17 @@ +Why use Startin'blox ? +*********************** + +Easy Use +======== +You can easily and quickly add a component to an existing application juste adding a script and a tag. We are currently working on making integration even easier with WordPress plugins. +You'll find in the framework everything you need to build an entiere application. To start a project in SiB, you just need a simple HTML file, add framework scripts and put tags. + +Decentralized +============= +Startin'blox was designed to be modular. You can integrate only one component to an existing application or build an entire application in SiB. You are not supposed to master javascript to use the framework but as we are still in development, it is advisable to have some notions + +Natively modular +================ + +.. warning:: + Give theroric exemple and use case. Graphic part.bling \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 5ce3cff..c638ca3 100644 --- a/source/index.rst +++ b/source/index.rst @@ -17,16 +17,11 @@ Welcome to Startinblox's documentation! :maxdepth: 2 :caption: How it work: - import_documentation/get-started - import_documentation/Use-a-component-alone-in-an-existing-application - import_documentation/build-full-application - import_documentation/the-basics - import_documentation/Components/index - import_documentation/Documentation-Component-Model - import_documentation/Events - import_documentation/Glossary - import_documentation/get-involved - import_documentation/Contribution-guidelines + import_documentation/sib-features + import_documentation/sib-demo + import_documentation/web-component + import_documentation/widgets + import_documentation/server-packages .. toctree:: :maxdepth: 2 -- GitLab