From a07db3cdcb470873c820ff6b98ef84b899b62153 Mon Sep 17 00:00:00 2001
From: Alice <alice.poggioli@hotmail.fr>
Date: Tue, 14 Apr 2020 11:18:04 +0200
Subject: [PATCH] update home
---
.../Solid-introduction.rst | 6 +-
source/import_documentation/get-involved.rst | 26 ++++++++
source/import_documentation/get-started.rst | 66 ++++++++-----------
source/index.rst | 10 +--
4 files changed, 62 insertions(+), 46 deletions(-)
create mode 100644 source/import_documentation/get-involved.rst
diff --git a/source/import_documentation/Solid-introduction.rst b/source/import_documentation/Solid-introduction.rst
index ad2a8cf..7e69cd3 100644
--- a/source/import_documentation/Solid-introduction.rst
+++ b/source/import_documentation/Solid-introduction.rst
@@ -2,15 +2,13 @@ SOLID is a standard that universalizes API
==========================================
`SOLID <https://solid.mit.edu/>`__ is a project start in 2015 and lead
-in the 3WC by `Tim Berners
-Lee <https://fr.wikipedia.org/wiki/Tim_Berners-Lee>`__, the inventor of
+in the 3WC by `Tim Berners Lee <https://fr.wikipedia.org/wiki/Tim_Berners-Lee>`__, the inventor of
the web. He was upset that his warning about the future of the web
wasn’t heard and that’s why he propose a new way to build web
application that give power back to the final user.
SOLID project has inspired Startin’blox a lot. This is the way we
-implement `SOLID
-specifications <https://github.com/solid/solid-spec>`__.
+implement `SOLID specifications <https://github.com/solid/solid-spec>`__.
Here is an example of our API :
diff --git a/source/import_documentation/get-involved.rst b/source/import_documentation/get-involved.rst
new file mode 100644
index 0000000..7010384
--- /dev/null
+++ b/source/import_documentation/get-involved.rst
@@ -0,0 +1,26 @@
+Get involved
+============
+Startin'blox is a young technology. If you want to participate in its development you can create components or look at the core of the framework.
+
+Create your components
+----------------------
+
+The components we develop tend to be as close as possible to `last standards <https://www.webcomponents.org/specs/>`__ in web. The objective is to build a library of reusable components to facilitate further development.
+
+What redundant functionality in web applications would you be interested in having available?
+
+=> `How to create your own components ? <How-to-make-components/>`__
+
+Go deeper in the framework
+--------------------------
+If you want to go further in the understanding of the framework, a developper documentation is dedicated to it.
+
+=> `See the developper documentation <https://developpers.startinblox.com/>`__
+
+Give us feedbacks
+-----------------
+The best thing you can do to help us in the development of startin'blox is to share your feedback, bug reports and suggestions. If needed, have a look on `our contribution guidelines <Contribution-guidelines/>`__
+
+=> `Come chat with us! <https://community.startinblox.com/>`__
+
+=> `Open an issue <https://git.startinblox.com/>`__
\ No newline at end of file
diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst
index 2f7594c..3f3747e 100644
--- a/source/import_documentation/get-started.rst
+++ b/source/import_documentation/get-started.rst
@@ -1,22 +1,41 @@
Get Started
===========
-Startin'blox is a front framework based on `official Web Component website <https://www.webcomponents.org/>`__ and `Linked Data conventions <https://www.w3.org/standards/semanticweb/data/>`__ to create interfaces compatible with the solid specifications.
+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/>`__.
+=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__.
-Try and learn Startin'blox
----------------------------
+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/>`__
-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
Play with Startin'blox
......................
To try the framework, you can play with
-- `our demo <https://startinblox.com/fr/technology#demo/>`__.
-- `our SiB builder <https://la-pommeraye.fr/sib-builder/#startinblox/core@latest/>`__.
+=> `our demo <https://startinblox.com/fr/technology#demo/>`__.
+=> `our SiB builder <https://la-pommeraye.fr/sib-builder/#startinblox/core@latest/>`__.
+
+
+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
@@ -34,43 +53,16 @@ You'll find in the framework everything you need to build an entiere application
=> `How to build a full application ? <build-full-application/>`__
-Glosssay
+Glossary
........
The glossary contains an overview of the most commonly used terms in the documentation.
-=> `Have a look on the glossary ? <Glossary/>`__
-
-
-Get involved
--------------
-Startin'blox is a young technology. If you want to participate in its development you can create components or look at the core of the framework.
-
-Create your components
-......................
-
-The components we develop tend to be as close as possible to `last standards <https://www.webcomponents.org/specs/>`__ in web. The objective is to build a library of reusable components to facilitate further development.
-
-What redundant functionality in web applications would you be interested in having available?
-
-=> `How to create your own components ? <How-to-make-components/>`__
-
-Go deeper in the framework
-..........................
-If you want to go further in the understanding of the framework, a developper documentation is dedicated to it.
-
-=> `See the developper documentation <https://developpers.startinblox.com/>`__
-
-Give us feedbacks
-.................
-The best thing you can do to help us in the development of startin'blox is to share your feedback, bug reports and suggestions. If needed, have a look on `our contribution guidelines <Contribution-guidelines/>`__
-
-=> `Come chat with us! <https://community.startinblox.com/>`__
-=> `Open an issue <https://git.startinblox.com/>`__
+=> `Have a look on the glossary <Glossary/>`__
Something is missing ?
-......................
+-----------------------
`Let's us know <https://mailto:alice@startinblox.com/>`__ !
diff --git a/source/index.rst b/source/index.rst
index 8be7c4a..7f333bb 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -9,15 +9,15 @@ Welcome to Startinblox's documentation!
import_documentation/Use-a-component-alone-in-an-existing-application
import_documentation/build-full-application
import_documentation/Components/index
- import_documentation/Contribution-guidelines
import_documentation/Documentation-Component-Model
import_documentation/Events
- import_documentation/Glossary
import_documentation/Helpers-functions
import_documentation/How-to-make-components
- import_documentation/Solid-introduction
-
- import_documentation/Why-Web-Components
import_documentation/devops/index
+ import_documentation/Glossary
import_documentation/philosophy
+ import_documentation/Solid-introduction
+ import_documentation/get-involved
+ import_documentation/Contribution-guidelines
+
--
GitLab