From 89ff7b11911644bee1dc81895471db881e6e06c0 Mon Sep 17 00:00:00 2001 From: Debian Date: Fri, 29 Aug 2025 16:29:05 +0000 Subject: [PATCH] =?UTF-8?q?feat:=20Consolidation=20de=20la=20documentation?= =?UTF-8?q?=20et=20suppression=20des=20templates=20g=C3=A9n=C3=A9riques?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.md | 25 ++++++++++++++++----- docs/guides_principaux.md | 7 ------ docs/guides_techniques.md | 8 ------- docs/templates/API.md | 8 ------- docs/templates/ARCHITECTURE.md | 8 ------- docs/templates/CONFIGURATION.md | 6 ----- docs/templates/INDEX.md | 12 ---------- docs/templates/OPEN_SOURCE_CHECKLIST.md | 7 ------ docs/templates/README.md | 29 ------------------------- docs/templates/RELEASE_PLAN.md | 7 ------ docs/templates/SECURITY_AUDIT.md | 7 ------ docs/templates/TESTING.md | 6 ----- docs/templates/USAGE.md | 7 ------ 13 files changed, 20 insertions(+), 117 deletions(-) delete mode 100644 docs/guides_principaux.md delete mode 100644 docs/guides_techniques.md delete mode 100644 docs/templates/API.md delete mode 100644 docs/templates/ARCHITECTURE.md delete mode 100644 docs/templates/CONFIGURATION.md delete mode 100644 docs/templates/INDEX.md delete mode 100644 docs/templates/OPEN_SOURCE_CHECKLIST.md delete mode 100644 docs/templates/README.md delete mode 100644 docs/templates/RELEASE_PLAN.md delete mode 100644 docs/templates/SECURITY_AUDIT.md delete mode 100644 docs/templates/TESTING.md delete mode 100644 docs/templates/USAGE.md diff --git a/docs/README.md b/docs/README.md index 32216db..d53ff37 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,12 +12,29 @@ Ce dossier documente l'API HTTP, l'architecture et les décisions techniques. - Service `StorageService` (voir `src/lib.rs`) encapsule la logique de stockage, récupération et nettoyage TTL. - `src/main.rs` démarre Tide avec état `StorageService` et une boucle de nettoyage périodique (60s). +## Concepts de Base + +- **Clés** : Format hexadécimal 64 caractères (32 octets) +- **Valeurs** : Format hexadécimal +- **TTL** : Durée de vie en secondes, sérialisé dans `*.meta` (UNIX timestamp secondes) +- **Persistance** : Système de fichiers, sous-dossiers par préfixe de clé + +## Fonctionnalités Techniques + +- **StorageService** : Abstraction des opérations de stockage +- **TTL** : Sérialisé dans `*.meta` (UNIX timestamp secondes) +- **Nettoyage** : Parcours des dossiers, suppression données expirées +- **Journalisation** : Sorties standard, intégration possible avec superviseur + +## Tests + +- **Tests unitaires** : Recommandés sur `StorageService` via répertoires temporaires +- **Tests d'intégration** : HTTP optionnels via client HTTP +- **Stratégies** : Cas TTL min/max, clés invalides, conflits de clé + Voir aussi: - `architecture.md` - `configuration.md` -- `guides_principaux.md` -- `guides_techniques.md` -- `guides_test.md` - `tests_monitoring.md` - `reseau_de_relais.md` - `developpement.md` @@ -37,5 +54,3 @@ Voir aussi: - Refactor initial de la logique depuis `main.rs` vers `lib.rs` pour testabilité et séparation des responsabilités. - Durées TTL maintenant validées dans le handler, calcul d'expiration converti en `SystemTime` avant l'appel service. - - diff --git a/docs/guides_principaux.md b/docs/guides_principaux.md deleted file mode 100644 index 4ce4992..0000000 --- a/docs/guides_principaux.md +++ /dev/null @@ -1,7 +0,0 @@ -# Guides Principaux - -- Concepts de base: clés hex 64, valeurs hex, TTL en secondes. -- API: `/store` (POST), `/retrieve/:key` (GET). -- Persistance: système de fichiers, sous-dossiers par préfixe de clé. - - diff --git a/docs/guides_techniques.md b/docs/guides_techniques.md deleted file mode 100644 index 18864a6..0000000 --- a/docs/guides_techniques.md +++ /dev/null @@ -1,8 +0,0 @@ -# Guides Techniques - -- `StorageService`: abstraction des opérations de stockage. -- TTL: sérialisé dans `*.meta` (UNIX timestamp secondes). -- Nettoyage: parcours des dossiers, suppression données expirées. -- Journalisation: sorties standard, intégration possible avec superviseur. - - diff --git a/docs/templates/API.md b/docs/templates/API.md deleted file mode 100644 index 431560f..0000000 --- a/docs/templates/API.md +++ /dev/null @@ -1,8 +0,0 @@ -# Référence API — Template - -- Vue d’ensemble -- Authentification/permissions -- Endpoints par domaine (schémas, invariants) -- Codes d’erreur -- Limites et quotas -- Sécurité et conformité diff --git a/docs/templates/ARCHITECTURE.md b/docs/templates/ARCHITECTURE.md deleted file mode 100644 index 42b78b2..0000000 --- a/docs/templates/ARCHITECTURE.md +++ /dev/null @@ -1,8 +0,0 @@ -# Architecture — Template - -- Contexte et objectifs -- Découpage en couches (UI, services, données) -- Flux principaux -- Observabilité -- CI/CD -- Contraintes et SLA diff --git a/docs/templates/CONFIGURATION.md b/docs/templates/CONFIGURATION.md deleted file mode 100644 index 3506069..0000000 --- a/docs/templates/CONFIGURATION.md +++ /dev/null @@ -1,6 +0,0 @@ -# Configuration — Template - -- Variables d’environnement (nom, type, défaut, portée) -- Fichiers de configuration (format, validation) -- Réseau et sécurité (ports, TLS, auth) -- Observabilité (logs, métriques, traces) diff --git a/docs/templates/INDEX.md b/docs/templates/INDEX.md deleted file mode 100644 index be566c0..0000000 --- a/docs/templates/INDEX.md +++ /dev/null @@ -1,12 +0,0 @@ -# Index — Templates de documentation (pour projets dérivés) - -Utilisez ces squelettes pour démarrer la documentation de votre projet. - -- API.md — squelette de référence API -- ARCHITECTURE.md — squelette d’architecture -- CONFIGURATION.md — squelette de configuration -- USAGE.md — squelette d’usage -- TESTING.md — squelette de stratégie de tests -- SECURITY_AUDIT.md — squelette d’audit sécurité -- RELEASE_PLAN.md — squelette de plan de release -- OPEN_SOURCE_CHECKLIST.md — squelette de checklist open source diff --git a/docs/templates/OPEN_SOURCE_CHECKLIST.md b/docs/templates/OPEN_SOURCE_CHECKLIST.md deleted file mode 100644 index 8406e38..0000000 --- a/docs/templates/OPEN_SOURCE_CHECKLIST.md +++ /dev/null @@ -1,7 +0,0 @@ -# Checklist open source — Template - -- Gouvernance: LICENSE, CONTRIBUTING, CODE_OF_CONDUCT -- CI/CD: workflows, tests, security-audit, release-guard -- Documentation: README, INDEX, guides essentiels -- Sécurité: secrets, permissions, audit -- Publication: tag, changelog, release notes diff --git a/docs/templates/README.md b/docs/templates/README.md deleted file mode 100644 index fe4d4bb..0000000 --- a/docs/templates/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# README — Template de projet - -## Présentation - -Décrivez brièvement l’objectif du projet, son périmètre et ses utilisateurs cibles. - -## Démarrage rapide - -- Prérequis (langages/outils) -- Étapes d’installation -- Commandes de démarrage - -## Documentation - -- Index: `docs/INDEX.md` -- Architecture: `docs/ARCHITECTURE.md` -- Configuration: `docs/CONFIGURATION.md` -- Tests: `docs/TESTING.md` -- Sécurité: `docs/SECURITY_AUDIT.md` -- Déploiement: `docs/DEPLOYMENT.md` - -## Contribution - -- GUIDE: `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md` -- Processus de PR et revues - -## Licence - -- Indiquez la licence choisie (MIT/Apache-2.0/GPL) diff --git a/docs/templates/RELEASE_PLAN.md b/docs/templates/RELEASE_PLAN.md deleted file mode 100644 index ab912bf..0000000 --- a/docs/templates/RELEASE_PLAN.md +++ /dev/null @@ -1,7 +0,0 @@ -# Plan de release — Template - -- Vue d’ensemble, objectifs, date cible -- Préparation (docs/CI/tests/sécurité) -- Communication (annonces, canaux) -- Lancement (checklist, tagging) -- Post‑lancement (support, retours) diff --git a/docs/templates/SECURITY_AUDIT.md b/docs/templates/SECURITY_AUDIT.md deleted file mode 100644 index 3876d6a..0000000 --- a/docs/templates/SECURITY_AUDIT.md +++ /dev/null @@ -1,7 +0,0 @@ -# Audit de sécurité — Template - -- Menaces et surfaces d’attaque -- Contrôles préventifs et détectifs -- Gestion des secrets -- Politique de dépendances -- Vérifications CI (security-audit) diff --git a/docs/templates/TESTING.md b/docs/templates/TESTING.md deleted file mode 100644 index 81a4b51..0000000 --- a/docs/templates/TESTING.md +++ /dev/null @@ -1,6 +0,0 @@ -# Tests — Template - -- Pyramide: unit, integration, connectivity, external, performance -- Structure des répertoires -- Exécution et rapports -- Intégration CI diff --git a/docs/templates/USAGE.md b/docs/templates/USAGE.md deleted file mode 100644 index 8cad2e9..0000000 --- a/docs/templates/USAGE.md +++ /dev/null @@ -1,7 +0,0 @@ -# Usage — Template - -- Démarrage quotidien -- Opérations courantes -- Tests (référence vers TESTING.md) -- Sécurité (référence vers SECURITY_AUDIT.md) -- Déploiement (référence vers DEPLOYMENT.md)