From 1ae9c4fcfb62edb598f721ca1db6b2af9cb99fb3 Mon Sep 17 00:00:00 2001 From: Debian Date: Fri, 29 Aug 2025 16:29:36 +0000 Subject: [PATCH] =?UTF-8?q?feat:=20Mise=20=C3=A0=20jour=20de=20l'index=20d?= =?UTF-8?q?e=20documentation=20et=20suppression=20des=20templates=20g?= =?UTF-8?q?=C3=A9n=C3=A9riques?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/INDEX.md | 91 ++++--------------------- 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 -- 11 files changed, 15 insertions(+), 173 deletions(-) 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/INDEX.md b/docs/INDEX.md index 0329a4b..7ed9719 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -128,74 +128,14 @@ Référence rapide pour les développeurs. - **Configuration rapide** - **Dépannage rapide** -### 🔄 [Guide de Migration](MIGRATION.md) -Guide pour les migrations et mises à jour. -- **Migration des versions** -- **Breaking changes** -- **Mise à jour des dépendances** -- **Migration des données** -- **Tests de migration** +## 📚 Exemples et Cas d'Usage -## 🌐 Guides d'Intégration - -### 🔗 [Intégration 4NK_node](INTEGRATION_4NK_NODE.md) -Guide d'intégration avec l'infrastructure 4NK_node. -- **Configuration Docker Compose** -- **Variables d'environnement** -- **Communication inter-services** -- **Déploiement intégré** -- **Monitoring et logs** - -### 🔑 [Configuration SSH](SSH_SETUP.md) -Guide de configuration SSH pour le développement. -- **Génération des clés SSH** -- **Configuration Git** -- **Intégration avec Gitea** -- **Automatisation des déploiements** - -### 🤖 [Push SSH Automatisé](AUTO_SSH_PUSH.md) -Guide pour l'automatisation des pushes SSH. -- **Configuration des scripts** -- **Intégration CI/CD** -- **Gestion des clés** -- **Sécurité et bonnes pratiques** - -## 📊 État et Monitoring - -### 📊 [État Actuel](ETAT_ACTUEL.md) -État détaillé du projet sdk_relay. -- **Statut des compilations** -- **Configuration des branches** -- **Fonctionnalités opérationnelles** -- **Métriques de performance** -- **Problèmes connus** - -### 📋 [Résumé Final](RESUME_FINAL.md) -Résumé complet de l'état final du projet. -- **Succès accomplis** -- **Prêt pour la production** -- **Documentation complète** -- **Support et maintenance** - -## 🔧 Guides d'Open Source - -### ✅ [Checklist Open Source](OPEN_SOURCE_CHECKLIST.md) -Checklist complète pour l'ouverture en open source. -- **Préparation du code** -- **Documentation** -- **Licences et légal** -- **Infrastructure** -- **Communication** - -## 📞 Support et Contact - -### 📞 [Support](SUPPORT.md) -Guide de support et contact. -- **Comment obtenir de l'aide** -- **Création d'issues** -- **Canal de communication** -- **FAQ** -- **Ressources additionnelles** +### 💡 [Exemples Pratiques](EXEMPLES_PRATIQUES.md) +Exemples concrets d'utilisation. +- **Cas d'usage typiques** +- **Exemples de code** +- **Intégrations** +- **Bonnes pratiques** ## 🚨 Dépannage @@ -215,14 +155,15 @@ Guide pour optimiser les performances. - **Benchmarks** - **Monitoring** -## 📚 Exemples et Cas d'Usage +## 📞 Support et Contact -### 💡 [Exemples Pratiques](EXEMPLES_PRATIQUES.md) -Exemples concrets d'utilisation. -- **Cas d'usage typiques** -- **Exemples de code** -- **Intégrations** -- **Bonnes pratiques** +### 📞 [Support](SUPPORT.md) +Guide de support et contact. +- **Comment obtenir de l'aide** +- **Création d'issues** +- **Canal de communication** +- **FAQ** +- **Ressources additionnelles** --- @@ -305,5 +246,3 @@ docker run -p 8090:8090 -p 8091:8091 sdk_relay --- **📚 Documentation complète pour sdk_relay - Service de relais pour les Silent Payments** 🚀 - - 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)