From 1f98c9806b7af10c535d927ad01bb2518d7292a1 Mon Sep 17 00:00:00 2001
From: mcmuzzle <vezuvan@hotmail.com>
Date: Mon, 9 Feb 2026 16:54:06 +0100
Subject: [PATCH] init de la documentation

---
 docker-dev/compose.yml               |  9 +++++
 documentation/InstallationPoste.adoc | 17 ++++++++++
 documentation/projectStructure.adoc  | 49 ++++++++++++++++++++++++++++
 3 files changed, 75 insertions(+)
 create mode 100644 docker-dev/compose.yml
 create mode 100644 documentation/InstallationPoste.adoc
 create mode 100644 documentation/projectStructure.adoc

diff --git a/docker-dev/compose.yml b/docker-dev/compose.yml
new file mode 100644
index 0000000..b2a2baf
--- /dev/null
+++ b/docker-dev/compose.yml
@@ -0,0 +1,9 @@
+services:
+
+  kroki:
+    container_name: kroki
+    image: yuzutech/kroki
+    ports:
+      - 8000:8000
+    volumes:
+      - ../.docker/kroki/data:/data
diff --git a/documentation/InstallationPoste.adoc b/documentation/InstallationPoste.adoc
new file mode 100644
index 0000000..fd3caca
--- /dev/null
+++ b/documentation/InstallationPoste.adoc
@@ -0,0 +1,17 @@
+
+== Installation de Poste
+
+==== rendu de la documentation
+
+pour visualiser la documentation il faut ajouter au `settings.json` :
+[source,json]
+----
+"asciidoc.extensions.enableKroki": true,
+"plantuml.includepaths": ["<chemin vers le dossier contenant les themes PlantUML>"],
+"plantuml.jar": "<Chemin vers le jar de PlantUML>",
+----
+
+de plus, il faut que le container kroki soit lancé, pour cela il faut exécuter la commande suivante à la racine du projet :
+[source,bash]
+docker compose -f docker-dev/compose.yml up -d kroki
+
diff --git a/documentation/projectStructure.adoc b/documentation/projectStructure.adoc
new file mode 100644
index 0000000..859b677
--- /dev/null
+++ b/documentation/projectStructure.adoc
@@ -0,0 +1,49 @@
+= Structure du projet LittleTown
+
+== Arborescence des dossiers
+
+[source,text]
+----
+LittleTown/
+├── .gitea/
+│   └── workflows/          # Pipelines CI/CD pour Gitea
+├── docker-dev/
+│   └── compose.yml         # Configuration Docker pour l'environnemenet de développement
+├── documentation/          # Documentation du projet
+├── scripts/                # Scripts d'automatisation (build, tests, déploiement)
+└── src/                    # Code source de l'application
+    ├── LittleTown.Api/                    # API backend (non utilisé actuellement)
+    ├── LittleTown.Blazor/                 # Application Blazor Server et WebAssembly
+    │   ├── LittleTown.Blazor/             # Application Blazor Server
+    │   └── LittleTown.Blazor.Client/      # Application Blazor WebAssembly
+    ├── LittleTown.Core/                   # Classes de domaine et modèles
+    ├── LittleTown.Core.Tests/             # Tests unitaires
+    └── LittleTown.StaticDataAccess/       # Accès aux données statiques
+----
+
+== Description des projets
+
+=== LittleTown.Api
+Projet de l'API backend. Pour le moment, il n'est pas utilisé dans l'architecture actuelle.
+
+=== LittleTown.Blazor
+Application principale utilisant Blazor Server et Blazor WebAssembly en mode interactif.
+
+* *LittleTown.Blazor* : Composant serveur, il inclut le projet .client
+* *LittleTown.Blazor.Client* : Composant client WebAssembly
+
+=== LittleTown.Core
+Cœur du domaine métier, contient :
+
+* *Aggregates* : Les agrégats DDD (Board, Match, PlayerZone)
+* *Enumerations* : Types énumérés du domaine
+* *Exceptions* : Exceptions métier
+* *PortInterfaces* : Interfaces des ports (architecture hexagonale)
+* *UseCases* : Cas d'utilisation métier
+* *ValueTypes* : Objets valeur du domaine
+
+=== LittleTown.Core.Tests
+Tests unitaires du domaine métier.
+
+=== LittleTown.StaticDataAccess
+Gestion de l'accès aux données statiques du jeu (cartes, ressources, configuration).
-- 
2.49.1