Improve docs (#53)

* Add basic docs * Improve docs * Move logo to docs * Fix coverpage and homepage
ottoszika · Dec 13, 2019 · 74023e0 · 74023e0
1 parent a86b01b
commit 74023e0
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![eWeLink + Node-RED](https://raw.githubusercontent.com/ottoszika/node-red-contrib-ewelink/master/images/ewelink-node-red.png)
+![eWeLink + Node-RED](https://raw.githubusercontent.com/ottoszika/node-red-contrib-ewelink/master/docs/images/logo.png)
 
 [![Build Status](https://travis-ci.com/ottoszika/node-red-contrib-ewelink.svg?branch=master)](https://travis-ci.com/ottoszika/node-red-contrib-ewelink)
 [![Coverage Status](https://coveralls.io/repos/github/ottoszika/node-red-contrib-ewelink/badge.svg?branch=master)](https://coveralls.io/github/ottoszika/node-red-contrib-ewelink?branch=master)

diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,4 +1,4 @@
-![eWeLink + Node-RED](https://raw.githubusercontent.com/ottoszika/node-red-contrib-ewelink/master/images/ewelink-node-red.png)
+![eWeLink + Node-RED](images/logo.png)
 
 [GitHub](https://github.com/ottoszika/node-red-contrib-ewelink)
 [Get Started](/get-started)
diff --git a/images/ewelink-node-red.png → docs/images/logo.png b/images/ewelink-node-red.png → docs/images/logo.png
diff --git a/docs/images/nodes/channels.png b/docs/images/nodes/channels.png
diff --git a/docs/images/nodes/device.png b/docs/images/nodes/device.png
diff --git a/docs/images/nodes/devices.png b/docs/images/nodes/devices.png
diff --git a/docs/images/nodes/event-listener.png b/docs/images/nodes/event-listener.png
diff --git a/docs/images/nodes/firmware.png b/docs/images/nodes/firmware.png
diff --git a/docs/images/nodes/humidity.png b/docs/images/nodes/humidity.png
diff --git a/docs/images/nodes/power-state-in.png b/docs/images/nodes/power-state-in.png
diff --git a/docs/images/nodes/power-state-out.png b/docs/images/nodes/power-state-out.png
diff --git a/docs/images/nodes/power-usage.png b/docs/images/nodes/power-usage.png
diff --git a/docs/images/nodes/temp-hum.png b/docs/images/nodes/temp-hum.png
diff --git a/docs/images/nodes/temperature.png b/docs/images/nodes/temperature.png
diff --git a/docs/index.html b/docs/index.html
@@ -13,6 +13,7 @@
   <script>
     window.$docsify = {
       coverpage: true,
+      homepage: 'get-started.md',
       loadSidebar: true,
       name: 'node-red-contrib-ewelink',
       repo: 'https://github.com/ottoszika/node-red-contrib-ewelink'

diff --git a/docs/nodes.md b/docs/nodes.md
@@ -1,8 +1,22 @@
 # Nodes
 
-There are several nodes than can be used to communicate with your devices.
+There are several nodes than can be used to communicate with your devices:
+* [Devices](#devices-node)
+* [Device (generic)](#device-node)
+* [Firmware](#firmware-node)
+* [Power state (in)](#power-state-in-node)
+* [Power state (out)](#power-state-out-node)
+* [Channels](#channels-node)
+* [Event listener](#event-listener-node)
+* [Power usage](#power-usage-node-node)
+* [Humidity](#humidity-node)
+* [Temperature](#temperature-node)
+* [Temperature and humidity](#temp-hum-node)
+
+#### [Devices node](#devices-node)
+
+![](images/nodes/devices.png)
 
-#### Devices node
 Using this node you can retrieve all the devices attached to your account.
 
 Result example:
@@ -19,8 +33,14 @@ Result example:
 ]
 ```
 
-#### Device node (generic)
+#### [Device node (generic)](#device-node)
+
+![](images/nodes/device.png)
+
 You can communicate with your devices using RPC-like syntax.
+
+A list of all methods you can find here: https://ewelink-api.now.sh/docs/available-methods 
+
 The input payload should look like:
 ```json
 {
@@ -37,7 +57,10 @@ Simple example to turn on a **Sonoff Basic** relay:
 }
 ```
 
-#### Firmware node
+#### [Firmware node](#firmware-node)
+
+![](images/nodes/firmware.png)
+
 Returns the current firmware version of a device.
 
 Result example:
@@ -48,7 +71,10 @@ Result example:
 }
 ```
 
-#### Power state node (in)
+#### [Power state node in](#powerstatein-node)
+
+![](images/nodes/power-state-in.png)
+
 Reads the current power state of a single channel device.
 
 Result example:
@@ -59,7 +85,10 @@ Result example:
 }
 ```
 
-#### Power state node (out)
+#### [Power state node (out)](#power-state-out-node)
+
+![](images/nodes/power-state-out.png)
+
 Sets the power state of a single channel device. The payload can be any of the following strings:
 * on
 * off
@@ -73,7 +102,10 @@ Result example:
 }
 ```
 
-#### Channels node
+#### [Channels node](#channels-node)
+
+![](images/nodes/channels.png)
+
 Returns the number of the channels for the device.
 
 Result example:
@@ -84,7 +116,10 @@ Result example:
 }
 ```
 
-#### Event listener node
+#### [Event listener node](#event-listener-node)
+
+![](images/nodes/event-listener.png)
+
 Listens to events of a devices. When a change occures it will return the event.
 By default it listens for events generated by all the devices, but you can specify a single device ID to listen on.
 
@@ -99,10 +134,16 @@ Result example:
 }
 ```
 
-#### Power usage node
+#### [Power usage node](#power-usage-node)
+
+![](images/nodes/power-usage.png)
+
 Returns the current month power usage on the device.
 
-#### Humidity node
+#### [Humidity node](#humidity-node)
+
+![](images/nodes/humidity.png)
+
 Returns the humidity value from the sensor connected to the device.
 
 Result example:
@@ -113,7 +154,10 @@ Result example:
 }
 ```
 
-#### Temperature node
+#### [Temperature node](#temperature-node)
+
+![](images/nodes/temperature.png)
+
 Returns the temperature value from the sensor connected to the device.
 
 Result example:
@@ -124,7 +168,10 @@ Result example:
 }
 ```
 
-#### Temperature and humidity node
+#### [Temperature and humidity node](#temp-hum-node)
+
+![](images/nodes/temp-hum.png)
+
 Returns the temperature and humidity value from the sensor connected to the device.
 
 Result example:
@@ -136,6 +183,4 @@ Result example:
 }
 ```
 
-[Go to the configuration →](configuration.md)
-
-[← Go back to the installation](installation.md)
+[← Go back to the configuration](configuration.md)