From b02e53256307d969e82b2a9f6b46cd3813f5963b Mon Sep 17 00:00:00 2001 From: Antone Barbaud Date: Wed, 10 Jun 2026 13:58:48 +0200 Subject: [PATCH] docs: organize diagrams to mirror code layout (util/ + features/) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move flat docs/diagrams/*.puml into a hierarchy matching the source package structure: docs/diagrams/ ├── bootstrap-sequence.puml (cross-cutting) ├── events-diagram.puml (cross-feature) ├── util/ │ ├── command-class-diagram.puml │ ├── database-diagram.puml │ ├── messages-class-diagram.puml │ ├── broadcasts-class-diagram.puml │ └── gui-class-diagram.puml └── features/ ├── team/ │ ├── team-class-diagram.puml │ ├── team-config-class-diagram.puml │ ├── builtin-commands-diagram.puml │ ├── team-create-sequence.puml │ ├── team-create-activity.puml │ └── team-join-sequence.puml ├── player/ │ └── player-class-diagram.puml └── moderation/ └── moderation-class-diagram.puml README.md diagram index split into 4 sections (overview, util, features/team, features/player, features/moderation) for readability; all links updated. features.md auto-updated by sed for the new paths. Co-Authored-By: Claude Opus 4.7 --- docs/README.md | 54 ++++++++++++++----- .../moderation}/moderation-class-diagram.puml | 0 .../player}/player-class-diagram.puml | 0 .../team}/builtin-commands-diagram.puml | 0 .../team}/team-class-diagram.puml | 0 .../team}/team-config-class-diagram.puml | 0 .../team}/team-create-activity.puml | 0 .../team}/team-create-sequence.puml | 0 .../team}/team-join-sequence.puml | 0 .../{ => util}/broadcasts-class-diagram.puml | 0 .../{ => util}/command-class-diagram.puml | 0 .../diagrams/{ => util}/database-diagram.puml | 0 .../{ => util}/gui-class-diagram.puml | 0 .../{ => util}/messages-class-diagram.puml | 0 docs/features.md | 26 ++++----- 15 files changed, 53 insertions(+), 27 deletions(-) rename docs/diagrams/{ => features/moderation}/moderation-class-diagram.puml (100%) rename docs/diagrams/{ => features/player}/player-class-diagram.puml (100%) rename docs/diagrams/{ => features/team}/builtin-commands-diagram.puml (100%) rename docs/diagrams/{ => features/team}/team-class-diagram.puml (100%) rename docs/diagrams/{ => features/team}/team-config-class-diagram.puml (100%) rename docs/diagrams/{ => features/team}/team-create-activity.puml (100%) rename docs/diagrams/{ => features/team}/team-create-sequence.puml (100%) rename docs/diagrams/{ => features/team}/team-join-sequence.puml (100%) rename docs/diagrams/{ => util}/broadcasts-class-diagram.puml (100%) rename docs/diagrams/{ => util}/command-class-diagram.puml (100%) rename docs/diagrams/{ => util}/database-diagram.puml (100%) rename docs/diagrams/{ => util}/gui-class-diagram.puml (100%) rename docs/diagrams/{ => util}/messages-class-diagram.puml (100%) diff --git a/docs/README.md b/docs/README.md index eef0ca7..90a7d10 100644 --- a/docs/README.md +++ b/docs/README.md @@ -62,23 +62,49 @@ d'initialisation côté plugin de jeu : ## Diagrammes +Organisés en miroir du code : `diagrams/util/` pour les utilitaires, +`diagrams/features//` pour les features, et les diagrammes +transverses à la racine. + +### Vue d'ensemble (transverse) + | Fichier | Type | Sujet | |---|---|---| -| [team-class-diagram.puml](diagrams/team-class-diagram.puml) | Classe | Domaine Team + abstractions communes | -| [team-create-sequence.puml](diagrams/team-create-sequence.puml) | Séquence | Création d'une équipe via la commande | -| [team-join-sequence.puml](diagrams/team-join-sequence.puml) | Séquence | Auto-join sur une équipe publique | -| [team-create-activity.puml](diagrams/team-create-activity.puml) | Activité | Flux de validation à la création | -| [player-class-diagram.puml](diagrams/player-class-diagram.puml) | Classe | Domaine Player + scores joueur | -| [command-class-diagram.puml](diagrams/command-class-diagram.puml) | Classe | Framework de commandes (nested) | -| [builtin-commands-diagram.puml](diagrams/builtin-commands-diagram.puml) | Classe | Arbre des commandes `/core team ...` | -| [events-diagram.puml](diagrams/events-diagram.puml) | Classe | Évènements Bukkit team + player | -| [database-diagram.puml](diagrams/database-diagram.puml) | Classe | Wrapper SQLite + table builder | -| [messages-class-diagram.puml](diagrams/messages-class-diagram.puml) | Classe | Service de messages YAML | -| [broadcasts-class-diagram.puml](diagrams/broadcasts-class-diagram.puml) | Classe | Service de broadcasts YAML + listener | -| [team-config-class-diagram.puml](diagrams/team-config-class-diagram.puml) | Classe | Paramètres d'équipe (cascade + GUI) | -| [gui-class-diagram.puml](diagrams/gui-class-diagram.puml) | Classe | Framework GUI réutilisable | -| [moderation-class-diagram.puml](diagrams/moderation-class-diagram.puml) | Classe | Feature modération (skeleton) | | [bootstrap-sequence.puml](diagrams/bootstrap-sequence.puml) | Séquence | `CRCore.enable()` côté plugin de jeu | +| [events-diagram.puml](diagrams/events-diagram.puml) | Classe | Évènements Bukkit team + player (cross-feature) | + +### `util/` — couche utilitaire + +| Fichier | Type | Sujet | +|---|---|---| +| [command-class-diagram.puml](diagrams/util/command-class-diagram.puml) | Classe | Framework de commandes (nested) | +| [database-diagram.puml](diagrams/util/database-diagram.puml) | Classe | Wrapper SQLite + table builder | +| [messages-class-diagram.puml](diagrams/util/messages-class-diagram.puml) | Classe | Service de messages YAML | +| [broadcasts-class-diagram.puml](diagrams/util/broadcasts-class-diagram.puml) | Classe | Service de broadcasts YAML + listener | +| [gui-class-diagram.puml](diagrams/util/gui-class-diagram.puml) | Classe | Framework GUI réutilisable | + +### `features/team/` + +| Fichier | Type | Sujet | +|---|---|---| +| [team-class-diagram.puml](diagrams/features/team/team-class-diagram.puml) | Classe | Domaine Team + abstractions communes | +| [team-config-class-diagram.puml](diagrams/features/team/team-config-class-diagram.puml) | Classe | Paramètres d'équipe (cascade + GUI) | +| [builtin-commands-diagram.puml](diagrams/features/team/builtin-commands-diagram.puml) | Classe | Arbre des commandes `/core team ...` | +| [team-create-sequence.puml](diagrams/features/team/team-create-sequence.puml) | Séquence | Création d'une équipe via la commande | +| [team-join-sequence.puml](diagrams/features/team/team-join-sequence.puml) | Séquence | Auto-join sur une équipe publique | +| [team-create-activity.puml](diagrams/features/team/team-create-activity.puml) | Activité | Flux de validation à la création | + +### `features/player/` + +| Fichier | Type | Sujet | +|---|---|---| +| [player-class-diagram.puml](diagrams/features/player/player-class-diagram.puml) | Classe | Domaine Player + scores joueur | + +### `features/moderation/` + +| Fichier | Type | Sujet | +|---|---|---| +| [moderation-class-diagram.puml](diagrams/features/moderation/moderation-class-diagram.puml) | Classe | Feature modération (skeleton) | ## Conventions diff --git a/docs/diagrams/moderation-class-diagram.puml b/docs/diagrams/features/moderation/moderation-class-diagram.puml similarity index 100% rename from docs/diagrams/moderation-class-diagram.puml rename to docs/diagrams/features/moderation/moderation-class-diagram.puml diff --git a/docs/diagrams/player-class-diagram.puml b/docs/diagrams/features/player/player-class-diagram.puml similarity index 100% rename from docs/diagrams/player-class-diagram.puml rename to docs/diagrams/features/player/player-class-diagram.puml diff --git a/docs/diagrams/builtin-commands-diagram.puml b/docs/diagrams/features/team/builtin-commands-diagram.puml similarity index 100% rename from docs/diagrams/builtin-commands-diagram.puml rename to docs/diagrams/features/team/builtin-commands-diagram.puml diff --git a/docs/diagrams/team-class-diagram.puml b/docs/diagrams/features/team/team-class-diagram.puml similarity index 100% rename from docs/diagrams/team-class-diagram.puml rename to docs/diagrams/features/team/team-class-diagram.puml diff --git a/docs/diagrams/team-config-class-diagram.puml b/docs/diagrams/features/team/team-config-class-diagram.puml similarity index 100% rename from docs/diagrams/team-config-class-diagram.puml rename to docs/diagrams/features/team/team-config-class-diagram.puml diff --git a/docs/diagrams/team-create-activity.puml b/docs/diagrams/features/team/team-create-activity.puml similarity index 100% rename from docs/diagrams/team-create-activity.puml rename to docs/diagrams/features/team/team-create-activity.puml diff --git a/docs/diagrams/team-create-sequence.puml b/docs/diagrams/features/team/team-create-sequence.puml similarity index 100% rename from docs/diagrams/team-create-sequence.puml rename to docs/diagrams/features/team/team-create-sequence.puml diff --git a/docs/diagrams/team-join-sequence.puml b/docs/diagrams/features/team/team-join-sequence.puml similarity index 100% rename from docs/diagrams/team-join-sequence.puml rename to docs/diagrams/features/team/team-join-sequence.puml diff --git a/docs/diagrams/broadcasts-class-diagram.puml b/docs/diagrams/util/broadcasts-class-diagram.puml similarity index 100% rename from docs/diagrams/broadcasts-class-diagram.puml rename to docs/diagrams/util/broadcasts-class-diagram.puml diff --git a/docs/diagrams/command-class-diagram.puml b/docs/diagrams/util/command-class-diagram.puml similarity index 100% rename from docs/diagrams/command-class-diagram.puml rename to docs/diagrams/util/command-class-diagram.puml diff --git a/docs/diagrams/database-diagram.puml b/docs/diagrams/util/database-diagram.puml similarity index 100% rename from docs/diagrams/database-diagram.puml rename to docs/diagrams/util/database-diagram.puml diff --git a/docs/diagrams/gui-class-diagram.puml b/docs/diagrams/util/gui-class-diagram.puml similarity index 100% rename from docs/diagrams/gui-class-diagram.puml rename to docs/diagrams/util/gui-class-diagram.puml diff --git a/docs/diagrams/messages-class-diagram.puml b/docs/diagrams/util/messages-class-diagram.puml similarity index 100% rename from docs/diagrams/messages-class-diagram.puml rename to docs/diagrams/util/messages-class-diagram.puml diff --git a/docs/features.md b/docs/features.md index 0cead2b..fb5433b 100644 --- a/docs/features.md +++ b/docs/features.md @@ -186,10 +186,10 @@ Postgres sans toucher au service. ### Diagrammes -- Classes : [team-class-diagram.puml](diagrams/team-class-diagram.puml) -- Séquence création : [team-create-sequence.puml](diagrams/team-create-sequence.puml) -- Séquence auto-join : [team-join-sequence.puml](diagrams/team-join-sequence.puml) -- Activité création : [team-create-activity.puml](diagrams/team-create-activity.puml) +- Classes : [team-class-diagram.puml](diagrams/features/team/team-class-diagram.puml) +- Séquence création : [team-create-sequence.puml](diagrams/features/team/team-create-sequence.puml) +- Séquence auto-join : [team-join-sequence.puml](diagrams/features/team/team-join-sequence.puml) +- Activité création : [team-create-activity.puml](diagrams/features/team/team-create-activity.puml) --- @@ -254,7 +254,7 @@ UUID pour rester déterministe). ### Diagrammes -- Classes : [player-class-diagram.puml](diagrams/player-class-diagram.puml) +- Classes : [player-class-diagram.puml](diagrams/features/player/player-class-diagram.puml) --- @@ -323,7 +323,7 @@ Voir [setup.md](setup.md#utilisation-depuis-un-plugin-de-jeu). ### Diagramme -- Classes : [command-class-diagram.puml](diagrams/command-class-diagram.puml) +- Classes : [command-class-diagram.puml](diagrams/util/command-class-diagram.puml) --- @@ -414,7 +414,7 @@ public class MyTeamCreate extends TeamCreateSubCommand { ### Diagramme -- Classes : [builtin-commands-diagram.puml](diagrams/builtin-commands-diagram.puml) +- Classes : [builtin-commands-diagram.puml](diagrams/features/team/builtin-commands-diagram.puml) --- @@ -513,7 +513,7 @@ db.table("my_kills") ### Diagramme -- Classes : [database-diagram.puml](diagrams/database-diagram.puml) +- Classes : [database-diagram.puml](diagrams/util/database-diagram.puml) --- @@ -680,7 +680,7 @@ placeholders documentés en commentaire. ### Diagramme -- Classes : [messages-class-diagram.puml](diagrams/messages-class-diagram.puml) +- Classes : [messages-class-diagram.puml](diagrams/util/messages-class-diagram.puml) --- @@ -803,7 +803,7 @@ depuis les fichiers user du dataFolder. Les defaults en jar ne bougent pas ### Diagramme -- Classes : [broadcasts-class-diagram.puml](diagrams/broadcasts-class-diagram.puml) +- Classes : [broadcasts-class-diagram.puml](diagrams/util/broadcasts-class-diagram.puml) --- @@ -915,8 +915,8 @@ est déjà enregistré par `CRCore.enable()`. ### Diagrammes -- [team-config-class-diagram.puml](diagrams/team-config-class-diagram.puml) -- [gui-class-diagram.puml](diagrams/gui-class-diagram.puml) +- [team-config-class-diagram.puml](diagrams/features/team/team-config-class-diagram.puml) +- [gui-class-diagram.puml](diagrams/util/gui-class-diagram.puml) --- @@ -1033,7 +1033,7 @@ core.moderation().getToolRegistry().register(new MyWarnTool()); ### Diagramme -- [moderation-class-diagram.puml](diagrams/moderation-class-diagram.puml) +- [moderation-class-diagram.puml](diagrams/features/moderation/moderation-class-diagram.puml) ---