Documentation : structure README / CLAUDE / DECISIONS / MONITORING

Nouveaux documents :
- README.md : porte d'entrée humaine, absente jusqu'ici. Objet du projet,
  installation, npm test, branchement Claude Desktop, ajout d'un profil WMS,
  compilation de l'exécutable.
- DECISIONS.md : 20 décisions et pièges vérifiés sur un WMS réel (D1..D20),
  chacun avec son pourquoi. Extrait ce qui était noyé dans CLAUDE.md :
  100 % API, tenant_code OAuth, réponses {entities}, casse des propriétés,
  dotenv sur stderr, dates relatives LINQ non traduisibles, absence de
  CommandParameterData, etc.
- MONITORING.md : supervision du serveur MCP. Préfixes de logs, séquence
  d'un démarrage sain, cycle de vie du token OAuth et ses trois filets,
  état des caches, table symptôme -> cause. Une section dit explicitement
  ce qui n'est pas instrumenté (ni healthcheck, ni métriques, ni alerte).
- docs/logs.md : accès aux logs du WMS. Chemins, placeholder {host},
  blocage volontaire sur les profils SaaS, les trois outils, format des
  lignes, limites connues.

Mises à jour :
- CLAUDE.md réécrit et aligné sur le code. Correction de l'écart le plus
  gênant : le code utilise QueryType 0 (Reading), la doc annonçait 1, soit
  l'inverse de ce qui fonctionne pour les comparaisons de statut par
  chaîne. Corrigés également : 6 resources et non 7 (workflows://categories
  n'existe pas), section .env mono-profil obsolète, références à des
  fichiers de test absents, README annoncé mais inexistant. Le suivi de
  projet et les checklists de phases sont retirés.
- docs/README.md : index réel du dossier. L'ancien promettait une resource
  docs:// qui n'a jamais existé.
- docs/getting_started.md : avertissement en tête, c'est une capture
  partielle du portail Mecalux dont les liens internes ne résolvent pas.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Arthur Ria
2026-08-24 15:15:31 +02:00
parent 9b95e15cbc
commit 0ff44f7b78
7 changed files with 1152 additions and 868 deletions
+36 -32
View File
@@ -1,41 +1,45 @@
# Documentation WMS
# Documentation de référence
Bienvenue dans la documentation du WMS !
Documents de référence sur EasyWMS et ses API, conservés dans le dépôt pour
être consultables hors ligne et par un agent qui lit le code.
## Comment utiliser cette documentation
> ⚠️ **Ce dossier n'est pas exposé comme resource MCP.** Une resource `docs://`
> a existé sans jamais être branchée ; elle a été supprimée. Ces fichiers se
> lisent directement depuis le dépôt. Voir D19 dans
> [DECISIONS.md](../DECISIONS.md).
Cette documentation est automatiquement accessible via le serveur MCP. Claude peut lire tous les fichiers `.md` présents dans ce dossier et ses sous-dossiers.
## Contenu
## Organisation
| Fichier | Nature |
|---|---|
| [logs.md](logs.md) | **Rédigé pour ce projet** — accès aux logs WMS, outils, limites |
| [ad-api-validation.md](ad-api-validation.md) | **Rédigé pour ce projet** — campagne de validation curl des 19 types AD testés (17 valides) |
| [api/Application Service API Reference.md](api/Application%20Service%20API%20Reference.md) | Référence de l'API ApplicationService |
| [api/POST apiQueryExecute.md](api/POST%20apiQueryExecute.md) | Détail de l'endpoint `QueryExecute` |
| [entities/easywms_reading_entites.md](entities/easywms_reading_entites.md) | Catalogue des entités du modèle **Reading** |
| [entities/easywms_reading_entites_outboundorder.md](entities/easywms_reading_entites_outboundorder.md) | Détail de l'entité `OutboundOrder` |
| [entities/easywms_reading_entites_outboundorder_OutboundOrderStatus.md](entities/easywms_reading_entites_outboundorder_OutboundOrderStatus.md) | Valeurs de `OutboundOrderStatus` |
| `getting_started.md`, `docs_downloads/` | Extractions du portail documentaire Mecalux |
| `reference-queries-api.php` | Client PHP d'origine, source des patterns d'API. ⚠️ utilise `QueryType: 1` — ne pas recopier, voir D3 |
Organisez vos fichiers de documentation comme vous le souhaitez :
**Sur les extractions du portail** : ce sont des captures partielles. Leurs
liens internes pointent vers des pages non téléchargées (`ReleaseNotes.md`,
`video_tutorials/`, …) et ne fonctionnent pas. Le seul document réellement
exploitable de cet ensemble est
`docs_downloads/communications/EasyWMS_WebApi_en.html.md` (référence complète de
la Web API, ~320 Ko).
```
docs/
├── README.md (ce fichier)
├── getting-started.md (guide de démarrage)
├── api/
│ ├── overview.md
│ └── endpoints.md
├── workflows/
│ ├── reception.md
│ └── expedition.md
└── troubleshooting/
└── common-errors.md
```
## Où trouver le reste
## Comment ajouter de la documentation
| Question | Document |
|---|---|
| À quoi sert ce projet, comment l'installer | [../README.md](../README.md) |
| Architecture, outils, resources, conventions de code | [../CLAUDE.md](../CLAUDE.md) |
| Pourquoi le code est écrit ainsi, pièges vérifiés | [../DECISIONS.md](../DECISIONS.md) |
| Le serveur ne répond pas / comment le superviser | [../MONITORING.md](../MONITORING.md) |
1. Créez vos fichiers `.md` dans ce dossier ou dans des sous-dossiers
2. Redémarrez Claude Desktop
3. Claude pourra automatiquement lire tous vos fichiers de documentation
## Ajouter un document
## Accéder à la documentation depuis Claude
Dans Claude Desktop, vous pouvez demander :
- "Montre-moi le sommaire de la documentation"
- "Lis la documentation sur les workflows"
- "Affiche-moi la documentation de l'API"
Claude aura accès à tous les fichiers `.md` présents ici !
Déposez le `.md` dans le sous-dossier qui convient et **ajoutez sa ligne au
tableau ci-dessus**. Un document non listé ici est un document que personne ne
retrouvera.