Updated docs (#4)

Author: xBlaz3kx

docker-compose.yaml

@@ -5,7 +5,6 @@ services:
       context: .
       target: website
     volumes:
-      - ./build/:/usr/share/nginx/html/
       - ./nginx.conf:/etc/nginx/nginx.conf
     labels:
       - "traefik.enable=true"

docs-hardware/hardware.md

@@ -39,7 +39,7 @@ The pinout will also vary depending on your preferred communication protocol. Th
 
 | Display |  Is supported    | 
 | :---:	| :---:	|
-|  HD44780    |  Yes |
+|  HD44780    |  ✔ |
 
 #### HD44780
 
@@ -82,7 +82,7 @@ It is highly recommended splitting both GND and VCC between relays or using a re
 
 | Power meter |  Is supported | 
 | :---:	| :---:	|
-|  CS5460A    |  Yes |
+|  CS5460A    |  ✔ |
 
 #### CS5460A
 
@@ -99,8 +99,8 @@ It is highly recommended splitting both GND and VCC between relays or using a re
 
 | Indicator |  Is supported | 
 | :---:	| :---:	|
-|  WS2812b    |  Yes |
-|  WS2811    |  Yes |
+|  WS2812b    |  ✔ |
+|  WS2811    |  ✔ |
 
 #### WS2811 and WS2812b
 

docs-services/graylog.md

@@ -6,16 +6,15 @@ sidebar_position: 1
 
 ## Prerequisites
 
-You should have a publicly accessible Linux or Windows server with Docker and docker-compose installed.
-
-See [Docker](https://docs.docker.com/engine/install/)
-and [docker-compose installation](https://docs.docker.com/compose/install/)
+You should have a publicly accessible Linux or Windows server with Docker and docker-compose installed. Check
+out [Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/)
 for installation guides.
 
 ## Running Graylog server with docker-compose
 
-1. Copy the following code into docker-compose.yaml. If cloning from GitHub, the docker-compose should be in the
-   _docs/services_ folder. There are two docker-compose files; the first one is the base and the second one uses Traefik
+1. Copy the following code into a docker-compose.yaml or use the
+   provided [docker-compose](https://github.com/xBlaz3kx/ChargePi-go/blob/main/docs/services/docker-compose.yaml). There
+   are two docker-compose files - the first one is the base and the second one uses [Traefik](https://traefik.io/) as a
    reverse proxy for routing.
 
 ```yaml
@@ -71,8 +70,16 @@ volumes:
     driver: local
 ```
 
-2. Run using:
+2. Change the `GRAYLOG_ROOT_PASSWORD_SHA2` as well as the external `GRAYLOG_HTTP_EXTERNAL_URI` environment variable.
+
+3. Run using:
+
+   ```bash
+   sudo docker-compose up -d
+   ```
+
+   or
 
-```bash
-sudo docker-compose up -d
-```
+   ```bash
+   sudo docker-compose -f docker-compose.yaml -f docker-compose.traefik.yaml up -d
+   ```

docs-services/mender.md

@@ -4,40 +4,37 @@ sidebar_position: 1
 
 # Charging station with Mender
 
-We will use [Mender](https://mender.io/) as OTA service for updating Linux, Docker and the client. For the OCPP
-server/central system, we will use **[SteVe](https://github.com/RWTH-i5-IDSG/steve)**.
+We will use [Mender](https://mender.io/) as OTA service for updating Linux, Docker and the client.
 
 1. Sign up on Mender. If you want, host a Mender server yourself.
 2. Follow this guide
    for [installing Mender on the Pi](https://docs.mender.io/get-started/preparation/prepare-a-raspberry-pi-device).
 3. Add the Raspberry to the Devices list and test if Mender works.
-4. Clone the SteVe repository to ChargePi/. It should automatically create steve folder.
-   *Skip this step if you do not want the server to be hosted on the same machine. Mostly used for testing purposes.*
-5. If you do not wish to automatically update the OCPP client, change this label to false in **docker-compose.yaml**:
+4. If you do not wish to automatically update the OCPP client, change this label to false in **docker-compose.yaml**:
 
-    ```yaml
-    chargepi:
-      label:
-        - com.centurylinklabs.watchtower.enable="false"
-    ```
-
-   **Not recommended when using Mender, since you can update the images with Mender.**
+```yaml
+   #Not recommended when using Mender, since you can update the images with Mender.
+   chargepi:
+     label:
+       - com.centurylinklabs.watchtower.enable="false"
+       #...
+```
 
 6. Run docker-compose:
 
    ```bash
    docker-compose up -d
    ```
 
-* Optionally, you can run only the client service:
-
-  ```bash
-  docker-compose up -d chargepi
-  ```
+   Optionally, you can run only the client service:
+   
+     ```bash
+     docker-compose up -d chargepi
+     ```
 
 ## Helpful references
 
 - [Installing Docker on Pi](https://www.docker.com/blog/happy-pi-day-docker-raspberry-pi/)
 - [Watchtower](https://github.com/containrrr/watchtower)
 - [Docker](https://docs.docker.com/)
-- [Mender docs](https://docs.mender.io/get-started/preparation/prepare-a-raspberry-pi-device)
+- [Mender docs](https://docs.mender.io/get-started/preparation/prepare-a-raspberry-pi-device)s.mender.io/get-started/preparation/prepare-a-raspberry-pi-device)

docs/go-client/adding-support-for-hardware.md

@@ -24,7 +24,7 @@ necessary logic that returns a pointer to the struct.
 The settings of the reader are read from the `settings` file, which is stored in the cache and are available in the
 NewTagReader method.
 
-```golang
+```go
 package reader
 
 const (
@@ -64,7 +64,7 @@ after the model of the display/LCD in the `hardware/display` package. Then you s
 the **model** of the display in the `display` file in the package and add a switch case with the implementation and the
 necessary logic that returns a pointer to the struct.
 
-```golang
+```go
 package display
 
 const (
@@ -113,7 +113,7 @@ func NewDisplay() LCD {
 
 The process is the same as the previous description.
 
-```golang
+```go
 package indicator
 
 const (
@@ -150,7 +150,7 @@ func NewIndicator(stripLength int) Indicator {
 
 The process is the same as the previous description.
 
-```golang
+```go
 package power_meter
 
 const (

docs/go-client/running-the-client.md

@@ -66,7 +66,7 @@ Alternatively, you can run the client, SteVe server and Watchtower on the same P
 The **[Watchtower](https://github.com/containrrr/watchtower)** service will automatically pull the newest image and run
 it when it is available.
 
-1. Change the IP address under __serverUri__ in the settings file to **172.0.1.121**.
+1. Change the IP address under `serverUri` in the settings file to **172.0.1.121**.
 
 2. Build services:
 

docs/intro.md

@@ -4,19 +4,19 @@ sidebar_position: 1
 
 # Getting Started
 
-ChargePi can be deployed/run in multiple ways:
+ChargePi client can be deployed/run in multiple ways:
 
 - standalone
-- Docker by building the image and running the container
-- Docker-compose to be deployed with SteVe Central System and Watchtower (**recommended for testing only**)
+- Docker 🐳 by building the image and running the container
+- Docker-compose to be deployed with SteVe Central System and Watchtower (**recommended for dev/testing only**)
 - Docker-compose by running the client
 
 ## Charging station specifications
 
 | Protocol implementation | Core functionalities | Offline charging | Local authorization | Charging profiles |
 | :---:    | :---:    | :---:    |:---:    | :---:    |
-| OCPP 1.6 JSON/WS | Yes | Yes | Yes | No |
-| OCPP 2.0.1 JSON/WS | Will be implemented | Will be implemented | Will be implemented | No |
+| OCPP 1.6 JSON/WS | ✔️ | ✔️ | ✔️ | ❌ |
+| OCPP 2.0.1 JSON/WS | Will be implemented | Will be implemented | Will be implemented | ❌ |
 
 ## Initial setup
 
@@ -30,11 +30,10 @@ ChargePi can be deployed/run in multiple ways:
    git clone https://github.com/RWTH-i5-IDSG/steve
    ```
 
-   *_When cloning Steve from GitHub, steve directory should be automatically generated._
-   Replace SteVe's default Dockerfile with Dockerfile provided in ChargePi/steve/Dockerfile to run on Raspberry Pi.
+   > Replace SteVe's Dockerfile with the one provided in order to run it on the Raspberry Pi.
 
-3. Configure the settings files according to the hardware and desired functionality. Check the docs/configuration folder
-   for configuration instructions.
+3. Configure the settings files according to the hardware and desired functionality with
+   the [guide](#configuration-and-settings).
 
 4. Build the underlying libraries.
 
@@ -43,13 +42,13 @@ ChargePi can be deployed/run in multiple ways:
 ### Configuration and settings
 
 To configure the ChargePi client, check out the [**configuration for Go**](go-client/configuration) or
-[**configuration for Python**](python-client/py-configuration). Client comes with predefined settings which require minimal
-configuration.
+[**configuration for Python**](python-client/py-configuration). Client comes with predefined settings which require
+minimal configuration.
 
 ## Graylog logging server
 
 ChargePi uses [Graylog](https://www.graylog.org/) logging server for remote logging, so a server should be up and
 running if you want the logs to be stored. Logs are sent through GELF UDP protocol.
 
-Configure the **"logServer"** property in the `settings` file with your server IP/domain name with the port.
-Setting up the logging server is described in the services section.
+Configure the **"logServer"** property in the `settings` file with your server IP/domain name with the port. Setting up
+the logging server is described in the services section.

docs/ocpp/ocpp-16.md

@@ -4,11 +4,10 @@ sidebar_position: 1
 
 # OCPP 1.6
 
-Configuration for protocol version 1.6 can be found in the `configuration` file.
+The default/reference configuration for protocol version 1.6 can be found in the `configuration` file.
 
 Each OCPP 1.6 configuration variable is represented as a dictionary with key equal to **variable name**, the **value**
-and
-**permission** attributes. For more information regarding OCPP 1.6 configuration,
+and **permission** attributes. For more information regarding OCPP 1.6 configuration,
 visit [the official docs](https://www.oasis-open.org/committees/download.php/58944/ocpp-1.6.pdf).
 
 ```json

docs/ocpp/ocpp-201.md

@@ -6,6 +6,8 @@ sidebar_position: 2
 
 Configuration for protocol version 2.0.1 can be found in _/charge_point/v201/configuration/configuration.json_.
 
+> Note: not available for the Go client (yet).
+
 In the protocol version 2.0.1, configuration variables are nested in Controllers (postfix - Ctrlr). Each controller has
 variables represented as a dictionary with attributes: **readOnly**, **value** and _optionally_ **unit**. Some
 controllers aren't completely supported. For more information regarding OCPP 2.0.1 configuration,