Enedis-OSS · MathieuSabarthes · Aug 20, 2025 · Aug 20, 2025 · Aug 20, 2025 · Aug 20, 2025
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@
 src/main/resources/TIC2WebSocket.properties
 target/
 var/
+docs/site/
diff --git a/README.fr.md b/README.fr.md
@@ -16,111 +16,21 @@
 
 ## Sommaire
 
-* [Introduction](#introduction)
-* [Installation](#installation)
-* [Exemple d'utilisation](#usage_example)
-* [Documentation](#documentation)
-* [Contribuer](#contrib)
-* [Support](#support)
-* [Contributeurs](#contributors)
+- [TIC2WebSocket](#tic2websocket)
+  - [Sommaire](#sommaire)
+  - [ Introduction](#-introduction)
+  - [ Documentation](#-documentation)
+  - [ Contributeurs](#-contributeurs)
 
 ## <a name="introduction"></a> Introduction
 
 L'application **TIC2WebSocket** est utilisée comme interface générique pour accéder aux données TIC (Télé Information Client).
 
 TIC2WebSocket fournit une API basée sur WebSocket pour gérer les données TIC, permettant une communication en temps réel et un échange de données pour les informations de télémétrie client.
 
-## <a name="installation"></a> Installation
-
-### Prérequis
-
-Pour générer/installer l'application, vous avez besoin des prérequis suivants :
-
-- [Java](https://www.java.com/download/)
-- [Maven](https://maven.apache.org/download.cgi)
-
-### Installation
-
-Pour installer l'application **TIC2WebSocket**, suivez ces étapes :
-
-#### Générer les fichiers cible
-Lorsque vous êtes à la racine du projet, tapez simplement la commande suivante :
-
-```bash 
-mvn clean package
-```
-
-En conséquence, le répertoire *target* est créé, contenant le fichier .zip de sortie.
-
-#### Extraire le fichier .zip
-Décompressez le fichier .zip dans le dossier de votre choix.
-
-🐧 **Linux**
-
-Extraire le zip
-```bash 
-unzip target/TIC2WebSocket-VERSION-bin -d /chemin/vers/votre/dossier
-```
-
-💻 **Windows**
-
-Extrayez `target/TIC2WebSocket-VERSION-bin` dans le dossier de votre choix.
-
-### Démarrage de l'Application
-
-Pour démarrer l'application **TIC2WebSocket**, exécutez le script de lancement :
-
-🐧 **Linux**
-
-Extraire le zip
-```bash 
-cd /chemin/vers/votre/dossier
-./TIC2WebSocket.sh
-```
-
-💻 **Windows**
-
-Exécutez `TIC2WebSocket.bat`
-
-### Aide
-
-Ajoutez l'option `--help` pour obtenir des informations de base sur l'utilisation du lanceur.
-```bash 
-./TIC2WebSocket.sh --help
-```
-
 ## <a name="documentation"></a> Documentation
 
-### Page HTML de test WebSocket
-
-Une page HTML autonome est disponible pour tester rapidement l’API WebSocket :
-
-- Fichier : [docs/ws-tester.html](docs/ws-tester.html)
-- URL par défaut : `ws://localhost:19584/`
-
-Fonctionnement :
-
-- Ouvrez la page dans un navigateur (optionnel : servez le dossier `docs/` via un serveur HTTP statique).
-- Renseignez l’URL WebSocket (ou host/port), puis cliquez sur `Connect`.
-- Choisissez une requête prédéfinie (`GetModemsInfo`, `GetAvailableTICs`, `ReadTIC`, `SubscribeTIC`, `UnsubscribeTIC`) puis cliquez sur `Send`.
-- Les filtres d’identifiant (SerialNumber / PortId / PortName) permettent de cibler un TIC.
-- Les messages entrants s’affichent dans Logs ; les messages de type `EVENT` sont regroupés par `(nom d’événement + identifiant)`.
-
-## <a name="contrib"></a> Contribuer ?
-
-![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
-
-Vous n'avez pas besoin d'être développeur pour contribuer, ni de faire beaucoup, vous pouvez simplement :
-* Améliorer la documentation,
-* Corriger une faute d'orthographe,
-* [Signaler un bug](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose)
-* [Demander une fonctionnalité](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose)
-* [Nous donner des conseils ou des idées](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose),
-* etc.
-
-Pour vous aider à démarrer, nous vous invitons à lire [Contributing](CONTRIBUTING.md), qui vous donne les règles et conventions de code à respecter
-
-Pour contribuer à cette documentation (README, CONTRIBUTING, etc.), nous nous conformons à la [CommonMark Spec](https://spec.commonmark.org/)
+Pour plus d'informations sur le fonctionnement de TIC2WebSocket, consultez la [documentation officielle](https://enedis-oss.github.io/tic2websocket/).
 
 ## <a name="contributors"></a> Contributeurs
 

diff --git a/README.md b/README.md
@@ -8,124 +8,36 @@
 -->
 
 # TIC2WebSocket
-*Tele Information Client (TIC) WebSocket Interface*
+*WebSocket interface for TIC (Tele Information Client) data*
 
 [![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)
 
 [🇫🇷 Français](README.fr.md) | [🇺🇸 English](README.md)
 
 ## Summary
 
-* [Introduction](#introduction)
-* [Installation](#installation)
-* [Usage Example](#usage_example)
-* [Documentation](#documentation)
-* [Contributing](#contrib)
-* [Support](#support)
-* [Contributors](#contributors)
+- [TIC2WebSocket](#tic2websocket)
+  - [Summary](#summary)
+  - [ Introduction](#-introduction)
+  - [ Documentation](#-documentation)
+  - [ Contributors](#-contributors)
 
 ## <a name="introduction"></a> Introduction
 
 The **TIC2WebSocket** application is used as a generic interface for accessing the Tele Information Client (TIC).
 
 TIC2WebSocket provides a WebSocket-based API for managing and interfacing with TIC data, enabling real-time communication and data exchange for client telemetry information.
 
-## <a name="installation"></a> Installation
-
-### Prerequisites
-
-To generate/install the application, you need the following prerequisites:
-
-- [Java](https://www.java.com/download/)
-- [Maven](https://maven.apache.org/download.cgi)
-
-### Installation
-
-To install the **TIC2WebSocket** application, follow these steps:
-
-#### Generate target files
-When you are at the project root, simply type the following command:
-
-```bash 
-mvn clean package
-```
-
-As a result, the *target* directory is created, containing the output .zip file.
-
-#### Extract .zip file
-Unzip the .zip file into the folder of your choice.
-
-🐧 **Linux**
-
-Extract zip
-```bash 
-unzip target/TIC2WebSocket-VERSION-bin -d /path/to/your/folder
-```
-
-💻 **Windows**
-
-Extract `target/TIC2WebSocket-VERSION-bin` in the folder of your choice.
-
-### Starting the Application
-
-To start the **TIC2WebSocket** application, execute the launch script:
-
-🐧 **Linux**
-
-Extract zip
-```bash 
-cd /path/to/your/folder
-./TIC2WebSocket.sh
-```
-
-💻 **Windows**
-
-Run `TIC2WebSocket.bat`
-
-### Help
-
-Add `--help` option to get basic information on how to use the launcher.
-```bash 
-./TIC2WebSocket.sh --help
-```
-
 ## <a name="documentation"></a> Documentation
 
-### WebSocket tester (HTML)
-
-A small, self-contained HTML page is available to quickly test the WebSocket API:
-
-- File: [docs/ws-tester.html](docs/ws-tester.html)
-- Default URL: `ws://localhost:19584/`
-
-How it works:
-
-- Open the page in a browser (optionally serve the `docs/` folder with any static server).
-- Set the WebSocket URL (or host/port), click `Connect`.
-- Pick a request preset (`GetModemsInfo`, `GetAvailableTICs`, `ReadTIC`, `SubscribeTIC`, `UnsubscribeTIC`) and click `Send`.
-- Optional identifier filters (SerialNumber / PortId / PortName) help target a specific TIC.
-- Incoming messages are displayed in the Logs panel; `EVENT` messages are grouped by `(event name + identifier)` for readability.
-
-## <a name="contrib"></a> Contributing ?
-
-![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
-
-You don't need to be a developer to contribute, nor do much, you can simply:
-* Enhance documentation,
-* Correct a spelling,
-* [Report a bug](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose)
-* [Ask a feature](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose)
-* [Give us advices or ideas](https://github.com/Enedis-OSS/TIC2WebSocket/issues/new/choose),
-* etc.
-
-To help you start, we invite you to read [Contributing](CONTRIBUTING.md), which gives you rules and code conventions to respect
+For more information about TIC2WebSocket, see the official documentation:
 
-To contribute to this documentation (README, CONTRIBUTING, etc.), we conform to the [CommonMark Spec](https://spec.commonmark.org/)
+- https://enedis-oss.github.io/tic2websocket/
 
 ## <a name="contributors"></a> Contributors
 
 Core contributors :
 * **Jehan BOUSCH** (<jehan-externe.bousch@enedis.fr>)
 * **Mathieu SABARTHES** (<matthieu-externe.sabarthes@enedis.fr>)
 
-We strive to provide a benevolent environment and support any [contribution](#contrib).
+We strive to provide a benevolent environment and support any contribution.
diff --git a/REUSE.toml b/REUSE.toml
@@ -17,4 +17,12 @@ path = [
     "**/*.svg"
 ]
 SPDX-FileCopyrightText = "2025 Enedis Smarties team <dt-dsi-nexus-lab-smarties@enedis.fr>"
+SPDX-License-Identifier = "Apache-2.0"
+
+# Documentation files are covered via REUSE annotations (no per-file header)
+[[annotations]]
+path = [
+    "docs/**"
+]
+SPDX-FileCopyrightText = "2025 Enedis Smarties team <dt-dsi-nexus-lab-smarties@enedis.fr>"
 SPDX-License-Identifier = "Apache-2.0"
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -0,0 +1,4 @@
+FROM squidfunk/mkdocs-material
+
+COPY requirements.txt .
+RUN pip install -r requirements.txt
diff --git a/docs/README.en.md b/docs/README.en.md
@@ -0,0 +1,10 @@
+[🇫🇷 Français](README.md) | [🇺🇸 English](README.en.md)
+
+# Developer setup
+
+From the project `docs` folder:
+
+- Start (PlantUML server + MkDocs server): `docker-compose up --build`
+- Stop: `docker-compose down`
+
+Then visit: http://localhost:8000/tic2websocket/ (the `/` root redirects to this path)
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,10 @@
+[🇫🇷 Français](README.md) | [🇺🇸 English](README.en.md)
+
+# Configuration pour les développeurs
+
+Depuis le dossier `docs` à la racine du projet :
+
+- Démarrer (serveur PlantUML + serveur MkDocs) : `docker-compose up --build` (ou `docker compose up --build`)
+- Arrêter : `docker-compose down`
+
+Puis visiter : http://localhost:8000/tic2websocket/ (la racine `/` redirige vers ce chemin)
diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml
@@ -0,0 +1,16 @@
+services:
+  plantuml:
+    image: plantuml/plantuml-server:tomcat
+    ports:
+      - "8080:8080"
+
+  mkdocs:
+    build: .
+    working_dir: /docs
+    volumes:
+      - ./:/docs
+    ports:
+      - "8000:8000"
+    command: serve --config-file mkdocs.yml --dev-addr 0.0.0.0:8000
+    depends_on:
+      - plantuml
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,3 +10,4 @@ @@
     src/main/resources/TIC2WebSocket.properties
     target/
     var/
+    docs/site/