From 99064681077a1dbaccb094edceb79097e82397fb Mon Sep 17 00:00:00 2001
From: ogghst <nicola.muratori@gmail.com>
Date: Sun, 16 Jan 2022 20:11:11 -0600
Subject: [PATCH] docs updated

---
 docs/platform.md  | 78 +++++++++++++++++++++++------------------------
 docs/reference.md | 78 +++++++++++++++++++++++------------------------
 2 files changed, 78 insertions(+), 78 deletions(-)

diff --git a/docs/platform.md b/docs/platform.md
index 60c89c71..df78f427 100644
--- a/docs/platform.md
+++ b/docs/platform.md
@@ -1,53 +1,53 @@
-# Reference Guide
+# A quick look into GrowNode systems
 
-## Node
+This page describes how the GrowNode platform is structured and the technology behind it. 
 
-### Responsibilites
-todo
+## Architecture
 
-### Configuration
-todo
+A full GrowNode system architecture is composed by
 
-### Examples
-todo
+ - one or more grownode boards (called nodes)
+ - each board is connected to several sensors (called leaves)
+ - a messaging server where each board talks using MQTT
+ - an automation server - like openhab, home assistant - that orchestrate the node operations
+ - several clients to display and manage nodes
+ - other systems, like home automation, gardening, that works together with grownode
 
+<p align="center">
+<img src="../img/grownode_net.png">
+</p>
 
-## Leaves
+## Working tools
 
-### Responsibilites
-todo
+GrowNode aims to use most common development tools. Actual release is composed by:
 
-### Configuration
-todo
+### Hardware
 
-### Examples
-todo
+ - [ESP32](https://www.espressif.com/en/products/socs/esp32) and above microcontrollers
+ - Common sensors and actuators (relay, PWM output, temperature probes, capacitance sensors..) with any esp-idf compatible libraries
+ 
+ - (optional) Various displays tested (ILI9341) with touch screen (tested XPT2046) capabilities
+ - (optional) A server like a raspberry to host the server side components in case you want to develop a network solution
+ 
 
-## Parameters
+### Software Components
 
-### Responsibilites
-todo
+ - ESP-IDF (release 4.4) programming environment
+ 
+ - (optional) MQTT broker as a messaging system - if you want to exchange info between boards and servers
+ - (optional) LVGL as display library - if you want to attach a screen to display your sensor values 
+ - (optional) OpenHab/Home Assistant as a controller 
 
-### Configuration
-todo
+## Functionalities
 
-### Examples
-todo
-
-## MQTT Protocol
-
-todo 
-
-### Leaf - Server messaging
-
-todo
-
-### Leaf - leaf messaging
-
-todo
-
-
-## Display Configuration
-
-todo
+Grownode provides functionalities that lets you kickstart your projects in minutes:
 
+- SoftAP/Bluetooth Provisioning to join and change your wireless network without any hardcode configuration through a mobile app
+- High level device configuration through makefile 
+- Firmware update Over The Air
+- NTP clock sync
+- Persistent storage of parameters
+- Sensor and Actuators configuration abstracting the hardware level
+- Transparent networking protocol (presentation, keepalive, logging)
+- Client/Server and Client/Client parameter retrieval and update through MQTT
+  
diff --git a/docs/reference.md b/docs/reference.md
index df78f427..60c89c71 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -1,53 +1,53 @@
-# A quick look into GrowNode systems
+# Reference Guide
 
-This page describes how the GrowNode platform is structured and the technology behind it. 
+## Node
 
-## Architecture
+### Responsibilites
+todo
 
-A full GrowNode system architecture is composed by
+### Configuration
+todo
 
- - one or more grownode boards (called nodes)
- - each board is connected to several sensors (called leaves)
- - a messaging server where each board talks using MQTT
- - an automation server - like openhab, home assistant - that orchestrate the node operations
- - several clients to display and manage nodes
- - other systems, like home automation, gardening, that works together with grownode
+### Examples
+todo
 
-<p align="center">
-<img src="../img/grownode_net.png">
-</p>
 
-## Working tools
+## Leaves
 
-GrowNode aims to use most common development tools. Actual release is composed by:
+### Responsibilites
+todo
 
-### Hardware
+### Configuration
+todo
 
- - [ESP32](https://www.espressif.com/en/products/socs/esp32) and above microcontrollers
- - Common sensors and actuators (relay, PWM output, temperature probes, capacitance sensors..) with any esp-idf compatible libraries
- 
- - (optional) Various displays tested (ILI9341) with touch screen (tested XPT2046) capabilities
- - (optional) A server like a raspberry to host the server side components in case you want to develop a network solution
- 
+### Examples
+todo
 
-### Software Components
+## Parameters
 
- - ESP-IDF (release 4.4) programming environment
- 
- - (optional) MQTT broker as a messaging system - if you want to exchange info between boards and servers
- - (optional) LVGL as display library - if you want to attach a screen to display your sensor values 
- - (optional) OpenHab/Home Assistant as a controller 
+### Responsibilites
+todo
 
-## Functionalities
+### Configuration
+todo
 
-Grownode provides functionalities that lets you kickstart your projects in minutes:
+### Examples
+todo
+
+## MQTT Protocol
+
+todo 
+
+### Leaf - Server messaging
+
+todo
+
+### Leaf - leaf messaging
+
+todo
+
+
+## Display Configuration
+
+todo
 
-- SoftAP/Bluetooth Provisioning to join and change your wireless network without any hardcode configuration through a mobile app
-- High level device configuration through makefile 
-- Firmware update Over The Air
-- NTP clock sync
-- Persistent storage of parameters
-- Sensor and Actuators configuration abstracting the hardware level
-- Transparent networking protocol (presentation, keepalive, logging)
-- Client/Server and Client/Client parameter retrieval and update through MQTT
-