Fixed markdown lint warnings.

Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>

9 files changed, 33 insertions, 32 deletions

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 91d5379..b1f04a2 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -9,5 +9,13 @@
         // Search
         // Configure glob patterns for excluding files and folders in searches. Inherits all glob patterns from the files.exclude setting.
         "search.exclude": {
-        }
+        },
+
+        "cSpell.words": [
+            "zypper", "TFTP", "devel", "syncthing", "journalctl", "systemctl",
+            "vbox", "aarch", "crosssdk", "corei", "templating", "LOGLEVEL",
+            "LOGFILE", "RPATH", "DRSYNC", "usermod", "groupmod", "chown",
+            "MACHINENAME", "glibc", "DESTDIR", "realpath", "GOARCH", "sdkid",
+            "newtool", "setx"
+        ]
 }
diff --git a/docs/part-1/0_Abstract.md b/docs/part-1/0_Abstract.md
index d0e32de..4b583d8 100644
--- a/docs/part-1/0_Abstract.md
+++ b/docs/part-1/0_Abstract.md
@@ -1,4 +1,4 @@
-# Part 1 - Getting Started for Users
+# Part 1 - Getting Started for Users
 
 ## Abstract
 
diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md
index b596e57..4a1d140 100644
--- a/docs/part-1/1_install-client.md
+++ b/docs/part-1/1_install-client.md
@@ -50,7 +50,7 @@ seb@laptop ~$  sudo zypper install agl-xds-gdb
 
   1. Add binary to PATH:
     - MacOs: create the .bash_profile `nano .bash_profile` and add `export PATH="/opt/AGL/xds/xds-agent:$PATH`
-    - Windows: change the system path via control panel or system settings or 
+    - Windows: change the system path via control panel or system settings or
     `setx path "C:\AGK\xds\xds-agent;%path%"`
 
 - repeat the previous steps to install other tools depending of your needs:
diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md
index fc80665..a4344f9 100644
--- a/docs/part-1/2_install-xds-server.md
+++ b/docs/part-1/2_install-xds-server.md
@@ -78,7 +78,7 @@ This container (ID=0) exposes following ports:
 - 69   : TFTP
 - 2222 : ssh
 
-This container also creates the following volumes (sharing directories between 
+This container also creates the following volumes (sharing directories between
 inside and outside docker):
 
 | Directory on host | Directory inside docker | Comment |
@@ -87,7 +87,6 @@ inside and outside docker):
 | $HOME/ssd/xdt_0 | /xdt | location to store SDKs |
 | $HOME/devel/docker/share |/home/devel/share | another shared directory |
 
-
 <!-- note -->
 Please refer to **part 2 - xds-server** documentation for additional info.
 <!-- endnote -->
@@ -131,7 +130,9 @@ seb@laptop ~$  sudo zypper install agl-xds-server
 
 ### Configure xds-server
 
-_Optional step: nothing to do if you keep default settings_
+<!-- note -->
+>**Optional step**: nothing to do if you keep default settings
+<!-- endnote -->
 
 When `xds-server` is started as a systemd service, default environment variables
 are set into `/etc/default/xds-server` file.
diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md
index d698bab..bb343b1 100644
--- a/docs/part-1/4_build-first-app.md
+++ b/docs/part-1/4_build-first-app.md
@@ -292,8 +292,10 @@ And define your own tasks, here is an example to build [unicens2-binding](https:
 > More details about VSC tasks [here](https://code.visualstudio.com/docs/editor/tasks)
 
 #### Qt Creator
+
 Please refer to [agl-hello-qml](https://github.com/radiosound-com/agl-hello-qml#clone--build-project) project.
 Thanks to Dennis for providing this useful example.
 
 #### Others IDE
+
 *Coming soon...*
diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/5_debug-first-app.md
index 38f2b67..6a4e95f 100644
--- a/docs/part-1/5_debug-first-app.md
+++ b/docs/part-1/5_debug-first-app.md
@@ -36,9 +36,9 @@ wrappers on `exec` command that allows to cross build your application through `
 
  `XDS_CONFIG`
  Config file defining `XDS_xxx` configuration variables. Variables of this file
- will overwrite inherited environment variables. Variables definition may be 
- prefixed or not by "export" keyword.  
- Here is an example of 
+ will overwrite inherited environment variables. Variables definition may be
+ prefixed or not by "export" keyword.
+ Here is an example of configuration file
 
 ```bash
 # for example:
@@ -80,7 +80,7 @@ Remote XDS server url
 
 ### Configuration variables set within gdb init command file
 
-Above `XDS_xxx` variables may also be defined within gdb init command file 
+Above `XDS_xxx` variables may also be defined within gdb init command file
 (see --command or -x option of genuine Gdb).
 You must respect the following syntax: commented line including `:XDS-ENV:` tag
 
diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md
index d7f511a..00b1b27 100644
--- a/docs/part-2/1_xds-server.md
+++ b/docs/part-2/1_xds-server.md
@@ -15,11 +15,6 @@ exposes a REST interface over HTTP and also provides a Web dashboard to configur
 `xds-server` uses [Syncthing](https://syncthing.net/) tool to synchronize
 projects files from user machine to build server machine or container.
 
-> **NOTE**: For now, only Syncthing sharing method is supported to synchronize
-projects files. But in a near future and for restricted configurations, `xds-server`
-will also support "standard" folder sharing (eg. nfs mount points or docker
-volumes).
-
 > **SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec),
 wrappers on `exec` commands that allows you to send commands to `xds-server`
 and for example build your application from command-line or from your favorite
@@ -79,6 +74,7 @@ This container (ID=0) exposes following ports:
 #### Manually setup docker user id
 
 If you plan to **use path-mapping sharing type for your projects**, you need to have the same user id and group id inside and outside docker. By default user and group name inside docker is set `devel` (id `1664`), use following commands to replace id `1664` with your user/group id:
+
 ```bash
 # Set docker container name to use (usually agl-xds-xxx where xxx is USERNAME@MACHINENAME-IDX-NAME)
 seb@laptop ~$ export CONTAINER_NAME=agl-xds-seb@laptop-0-seb
@@ -307,7 +303,7 @@ below corresponds to the default values):
 The server part is written in *Go* and web app / dashboard (client part) in
 *Angular2*.
 
-```
+```bash
 |
 +-- bin/                where xds-server binary file will be built
 |
diff --git a/docs/part-2/3_xds-exec.md b/docs/part-2/3_xds-exec.md
index 7487947..96f3968 100644
--- a/docs/part-2/3_xds-exec.md
+++ b/docs/part-2/3_xds-exec.md
@@ -9,12 +9,6 @@ This tool can be used in lieu of "standard" `exec` command to execute any
 command on a remote `xds-server`. For example you can trig your project build by
 executing : `xds-exec --config conf.env -- make build`
 
-> **SEE ALSO**:
->  - [xds-agent](https://github.com/iotbzh/xds-agent), an agent that should run
-on your local host in order to use XDS.
->  - [xds-server](https://github.com/iotbzh/xds-server), a web server
-used to remotely cross build applications.
-
 ## Configuration
 
 `xds-exec` configuration is defined either by environment variables or by
@@ -43,12 +37,12 @@ Env config file to source on startup
 
 Logging level, supported levels are:
 
-* panic,
-* fatal,
-* error,
-* warn,
-* info,
-* debug
+- panic,
+- fatal,
+- error,
+- warn,
+- info,
+- debug
 
 Default level is "error".
 
@@ -98,7 +92,7 @@ So you should replace `xds-server` in `vendor` directory by a symlink.
 So clone first `xds-server` sources next to `xds-exec` directory.
 You should have the following tree:
 
-```
+```bash
 > tree -L 3 src
 src
 |-- github.com
diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md
index 9905eee..529dc51 100644
--- a/docs/part-2/4_xds-gdb.md
+++ b/docs/part-2/4_xds-gdb.md
@@ -39,7 +39,7 @@ wrappers on `exec` command that allows to cross build your application through `
 
  `XDS_CONFIG` :
  Config file defining `XDS_xxx` configuration variables. Variables of this file
- will overwrite inherited environment variables. Variables definition may be 
+ will overwrite inherited environment variables. Variables definition may be
  prefixed or not by "export" keyword.
  Here is an example of config file
 
@@ -81,8 +81,8 @@ Remote XDS server url
 
 ### Configuration variables set within gdb init command file
 
-Above `XDS_xxx` variables may also be defined within gdb init command file 
-(see --command or -x option of genuine Gdb).  
+Above `XDS_xxx` variables may also be defined within gdb init command file
+(see --command or -x option of genuine Gdb).
 You must respect the following syntax: commented line including `:XDS-ENV:` tag
 
 Example of gdb init file where we define project and sdk ID: