feat: Consolidation de la documentation et suppression des templates génériques
Some checks failed
Docker Image / docker (push) Failing after 19s

This commit is contained in:
Debian 2025-08-29 16:29:05 +00:00
parent 59821b1d41
commit 89ff7b1191
13 changed files with 20 additions and 117 deletions

View File

@ -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. - 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). - `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: Voir aussi:
- `architecture.md` - `architecture.md`
- `configuration.md` - `configuration.md`
- `guides_principaux.md`
- `guides_techniques.md`
- `guides_test.md`
- `tests_monitoring.md` - `tests_monitoring.md`
- `reseau_de_relais.md` - `reseau_de_relais.md`
- `developpement.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. - 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. - Durées TTL maintenant validées dans le handler, calcul d'expiration converti en `SystemTime` avant l'appel service.

View File

@ -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é.

View File

@ -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.

View File

@ -1,8 +0,0 @@
# Référence API — Template
- Vue densemble
- Authentification/permissions
- Endpoints par domaine (schémas, invariants)
- Codes derreur
- Limites et quotas
- Sécurité et conformité

View File

@ -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

View File

@ -1,6 +0,0 @@
# Configuration — Template
- Variables denvironnement (nom, type, défaut, portée)
- Fichiers de configuration (format, validation)
- Réseau et sécurité (ports, TLS, auth)
- Observabilité (logs, métriques, traces)

View File

@ -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 darchitecture
- CONFIGURATION.md — squelette de configuration
- USAGE.md — squelette dusage
- TESTING.md — squelette de stratégie de tests
- SECURITY_AUDIT.md — squelette daudit sécurité
- RELEASE_PLAN.md — squelette de plan de release
- OPEN_SOURCE_CHECKLIST.md — squelette de checklist open source

View File

@ -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

View File

@ -1,29 +0,0 @@
# README — Template de projet
## Présentation
Décrivez brièvement lobjectif du projet, son périmètre et ses utilisateurs cibles.
## Démarrage rapide
- Prérequis (langages/outils)
- Étapes dinstallation
- 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)

View File

@ -1,7 +0,0 @@
# Plan de release — Template
- Vue densemble, objectifs, date cible
- Préparation (docs/CI/tests/sécurité)
- Communication (annonces, canaux)
- Lancement (checklist, tagging)
- Postlancement (support, retours)

View File

@ -1,7 +0,0 @@
# Audit de sécurité — Template
- Menaces et surfaces dattaque
- Contrôles préventifs et détectifs
- Gestion des secrets
- Politique de dépendances
- Vérifications CI (security-audit)

View File

@ -1,6 +0,0 @@
# Tests — Template
- Pyramide: unit, integration, connectivity, external, performance
- Structure des répertoires
- Exécution et rapports
- Intégration CI

View File

@ -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)