Docs improvements (#18)

* Docs improvements
theengs · Sep 27, 2021 · a0122a8 · a0122a8
1 parent 9c9fe58
commit a0122a8
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,21 @@
-Theengs Decoder project aims to provide an efficient, portable and lightweight library for Internet of Things decoding.
-Sensors and devices use chains of data to communicate to gateways, computers, servers. Enabling to have lightweight and fast communication, on the other hand we have a huge diversity of communication methods, resulting in the sensors or devices to be closed to one ecosystem or a few.
-Theengs decoder is a library that gather things decoders and operate them so as to understand these things on a common format. This format can easily be integrated into different systems, these systems will be open thanks to the capabilities offered by the Theengs Decoder.
+Theengs Decoder project aims to provide an efficient, portable and lightweight library for Internet of Things messages decoding.
 
-Theengs Decoder leverages json format to receive data and provide an enriched output.
-It's also a simplified way of defining the thing properties and how to decode these.
+![Iot](/docs/img/Theengs_decoder_iot_chain.jpg)
+
+Sensors and devices use chains of data to communicate to gateways, computers, servers. Enabling them to have lightweight and fast communication.
+On the other hand we have a huge diversity of communication methods, resulting in the sensors or devices being closed to one ecosystem or a few.
+
+Theengs decoder library translates these data chains into human readable data leveraging the well known data interchange format JSON. This format can easily be integrated into different systems or software.
 
 ![Overview](/docs/img/Theengs_decoder.jpg)
 
-Theengs Decoder can be used on memory constraint environment like micro controllers (ESP32, ESP8266, Arduino), on PC or on a Unix server.
-It is setup with unit testing so as to assure that the modification done on the library doesn't affect previous capabilities.
+It's also a simplified way of defining the thing properties and how to decode these.
+
+Theengs Decoder can be used on memory constraint environments like micro controllers (ESP32, ESP8266, Arduino), on PC or on a Unix server.
+Unit testing assures that the modification done on the library doesn't affect previous capabilities.
 
 In a few words:
 * Light
 * Portable
 * Expandable
-* Interoperable
+* Interoperable
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -68,9 +68,9 @@ module.exports = {
           title: '3 - Participate 💻',   // required
           sidebarDepth: 1,    // optional, defaults to 1
           children: [
+            'participate/adding-decoders',
             'participate/support',
-            'participate/development',
-            'participate/adding-decoders'
+            'participate/development'
           ]
         }
     ]

diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,14 @@
-![Overview](./img/Theengs_decoder.jpg)
 Theengs Decoder project aims to provide an efficient, portable and lightweight library for Internet of Things messages decoding.
 
+![Iot](./img/Theengs_decoder_iot_chain.jpg)
+
 Sensors and devices use chains of data to communicate to gateways, computers, servers. Enabling them to have lightweight and fast communication.
 On the other hand we have a huge diversity of communication methods, resulting in the sensors or devices being closed to one ecosystem or a few.
 
 Theengs decoder library translates these data chains into human readable data leveraging the well known data interchange format JSON. This format can easily be integrated into different systems or software.
 
+![Overview](./img/Theengs_decoder.jpg)
+
 It's also a simplified way of defining the thing properties and how to decode these.
 
 Theengs Decoder can be used on memory constraint environments like micro controllers (ESP32, ESP8266, Arduino), on PC or on a Unix server.

diff --git a/docs/devices/LYWSD03MMC_ATC.md b/docs/devices/LYWSD03MMC_ATC.md
@@ -1,4 +1,5 @@
 # Xiaomi LYWSD03MMC ATC
+![LYWSD03MMC](./../img/LYWSD03MMC.png)
 
 |Model Id|[LYWSD03MMC_ATC](./../../src/devices/LYWSD03MMC_ATC_json.h)|
 |-|-|

diff --git a/docs/devices/LYWSD03MMC_PVVX.md b/docs/devices/LYWSD03MMC_PVVX.md
@@ -1,4 +1,5 @@
 # Xiaomi LYWSD03MMC PVVX
+![LYWSD03MMC](./../img/LYWSD03MMC.png)
 
 |Model Id|[LYWSD03MMC_PVVX](./../../src/devices/LYWSD03MMC_PVVX_json.h)|
 |-|-|

diff --git a/docs/img/LYWSD03MMC.png b/docs/img/LYWSD03MMC.png
diff --git a/docs/img/Theengs_decoder_iot_chain.jpg b/docs/img/Theengs_decoder_iot_chain.jpg
diff --git a/docs/participate/adding-decoders.md b/docs/participate/adding-decoders.md
@@ -4,7 +4,6 @@ Adding your device protocol to Theengs decoder enable to increase interoperabili
 
 You can do a pull request directly to the [Repository](https://github.com/theengs/decoder).
 
-
 # Adding device decoding
 
 Device decode specifications are located in a json file, example [HHCCJCY01HHCC_json.h](../../src/device_json.h). The format is:

diff --git a/docs/participate/support.md b/docs/participate/support.md
@@ -1,6 +1,7 @@
 # Supporting the project
 
 If you like the project and/or used it please consider supporting it! It can be done in different ways:
+* Helping others in the [community](https://github.com/theengs/decoder/discussions)
 * [Contribute](development) to the [code](https://github.com/theengs/decoder) or the documentation,
 * Buy devices, boards or parts from the [OpenMQTTGateway compatible web site](https://compatible.openmqttgateway.com), the devices and parts linked use affiliated links,
 * Donate or sponsor the project [developpers](https://github.com/theengs/decoder/graphs/contributors)