doc cleanup
This commit is contained in:
Debian
parent
db53cfd05e
commit
35c6b1b61d
@ -223,5 +223,3 @@ cargo test --all
|
|||||||
---
|
---
|
||||||
|
|
||||||
**📚 Documentation complète pour sdk_client — SDK client pour les Silent Payments** 🚀
|
**📚 Documentation complète pour sdk_client — SDK client pour les Silent Payments** 🚀
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,380 +0,0 @@
|
|||||||
# 🔄 Guide de Migration - Documentation sdk_client
|
|
||||||
|
|
||||||
Guide pour migrer et organiser la documentation existante vers la nouvelle structure.
|
|
||||||
|
|
||||||
## 📋 État Actuel
|
|
||||||
|
|
||||||
### Fichiers de Documentation Existants
|
|
||||||
|
|
||||||
#### Documentation Principale
|
|
||||||
- `README.md` - Documentation principale (mis à jour)
|
|
||||||
- `EXEMPLES_PRATIQUES.md` - Exemples d'utilisation (à migrer)
|
|
||||||
|
|
||||||
#### Documentation Technique
|
|
||||||
- `specs/spec-technique.md` - Spécification technique (à conserver)
|
|
||||||
- `specs/spec-fonctionnel.md` - Spécification fonctionnelle (à conserver)
|
|
||||||
- `specs/spec-technical.md` - Spécification technique (à fusionner)
|
|
||||||
|
|
||||||
#### Documentation de Configuration
|
|
||||||
- `CONFIGURATION_DEV3.md` - Configuration dev3.4nkweb.com (à migrer)
|
|
||||||
- `INTEGRATION_DEV3_FINAL.md` - Intégration dev3.4nkweb.com (à migrer)
|
|
||||||
|
|
||||||
#### Documentation de Processus
|
|
||||||
- `COMMANDES_REDEMARRAGE.md` - Commandes de redémarrage (à migrer)
|
|
||||||
- `RESUME_AJOUT_DEV3.md` - Résumé ajout dev3 (à migrer)
|
|
||||||
- `RESUME_DECOUVERTE_NOEUDS.md` - Découverte des nœuds (à migrer)
|
|
||||||
- `RESUME_SCRIPT_RESTART.md` - Script de redémarrage (à migrer)
|
|
||||||
- `RESUME_TEST_3_RELAIS.md` - Test 3 relais (à migrer)
|
|
||||||
|
|
||||||
#### Documentation de Scripts
|
|
||||||
- `README_RESTART_SCRIPT.md` - Documentation script redémarrage (à migrer)
|
|
||||||
- `explain_node_discovery.md` - Explication découverte nœuds (à migrer)
|
|
||||||
|
|
||||||
## 🎯 Plan de Migration
|
|
||||||
|
|
||||||
### 1. Structure de Documentation
|
|
||||||
|
|
||||||
```
|
|
||||||
4NK_node/
|
|
||||||
├── README.md # ✅ Mis à jour
|
|
||||||
├── docs/ # ✅ Nouvelle structure
|
|
||||||
│ ├── INDEX.md # ✅ Créé
|
|
||||||
│ ├── INSTALLATION.md # ✅ Créé
|
|
||||||
│ ├── USAGE.md # ✅ Créé
|
|
||||||
│ ├── CONFIGURATION.md # ✅ Créé
|
|
||||||
│ ├── QUICK_REFERENCE.md # ✅ Créé
|
|
||||||
│ ├── MIGRATION.md # ✅ Ce fichier
|
|
||||||
│ ├── ARCHITECTURE.md # 🔄 À créer
|
|
||||||
│ ├── API.md # 🔄 À créer
|
|
||||||
│ ├── SECURITY.md # 🔄 À créer
|
|
||||||
│ ├── PERFORMANCE.md # 🔄 À créer
|
|
||||||
│ ├── TESTING.md # 🔄 À créer
|
|
||||||
│ ├── SYNC_TESTING.md # 🔄 À créer
|
|
||||||
│ ├── PERFORMANCE_TESTING.md # 🔄 À créer
|
|
||||||
│ ├── RELAY_NETWORK.md # 🔄 À créer
|
|
||||||
│ ├── EXTERNAL_NODES.md # 🔄 À créer
|
|
||||||
│ ├── SYNCHRONIZATION.md # 🔄 À créer
|
|
||||||
│ ├── TROUBLESHOOTING.md # 🔄 À créer
|
|
||||||
│ └── FAQ.md # 🔄 À créer
|
|
||||||
├── specs/ # ✅ À conserver
|
|
||||||
│ ├── spec-technique.md # ✅ Conserver
|
|
||||||
│ └── spec-fonctionnel.md # ✅ Conserver
|
|
||||||
├── archive/ # 🔄 À créer
|
|
||||||
│ ├── docs/ # 🔄 Anciens fichiers
|
|
||||||
│ └── README.md # 🔄 Documentation archive
|
|
||||||
└── examples/ # 🔄 À créer
|
|
||||||
├── configuration/ # 🔄 Exemples de config
|
|
||||||
├── scripts/ # 🔄 Scripts d'exemple
|
|
||||||
└── tests/ # 🔄 Tests d'exemple
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Migration des Fichiers
|
|
||||||
|
|
||||||
#### Fichiers à Migrer vers `docs/`
|
|
||||||
|
|
||||||
| Fichier Source | Destination | Statut |
|
|
||||||
|----------------|-------------|---------|
|
|
||||||
| `EXEMPLES_PRATIQUES.md` | `docs/USAGE.md` | ✅ Intégré |
|
|
||||||
| `CONFIGURATION_DEV3.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
|
||||||
| `INTEGRATION_DEV3_FINAL.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
|
||||||
| `COMMANDES_REDEMARRAGE.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
|
||||||
| `RESUME_AJOUT_DEV3.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
|
||||||
| `RESUME_DECOUVERTE_NOEUDS.md` | `docs/RELAY_NETWORK.md` | 🔄 À migrer |
|
|
||||||
| `RESUME_SCRIPT_RESTART.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
|
||||||
| `RESUME_TEST_3_RELAIS.md` | `docs/SYNC_TESTING.md` | 🔄 À migrer |
|
|
||||||
| `README_RESTART_SCRIPT.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
|
||||||
| `explain_node_discovery.md` | `docs/RELAY_NETWORK.md` | 🔄 À migrer |
|
|
||||||
|
|
||||||
#### Fichiers à Conserver
|
|
||||||
|
|
||||||
| Fichier | Raison | Action |
|
|
||||||
|---------|--------|---------|
|
|
||||||
| `specs/spec-technique.md` | Documentation technique détaillée | ✅ Conserver |
|
|
||||||
| `specs/spec-fonctionnel.md` | Spécification fonctionnelle | ✅ Conserver |
|
|
||||||
| `specs/spec-technical.md` | Spécification technique | 🔄 Fusionner avec spec-technique.md |
|
|
||||||
|
|
||||||
#### Fichiers à Archiver
|
|
||||||
|
|
||||||
| Fichier | Action |
|
|
||||||
|---------|--------|
|
|
||||||
| `EXEMPLES_PRATIQUES.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `CONFIGURATION_DEV3.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `INTEGRATION_DEV3_FINAL.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `COMMANDES_REDEMARRAGE.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `RESUME_AJOUT_DEV3.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `RESUME_DECOUVERTE_NOEUDS.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `RESUME_SCRIPT_RESTART.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `RESUME_TEST_3_RELAIS.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `README_RESTART_SCRIPT.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
| `explain_node_discovery.md` | 🔄 Déplacer vers `archive/docs/` |
|
|
||||||
|
|
||||||
## 🔄 Processus de Migration
|
|
||||||
|
|
||||||
### Étape 1 : Créer la Structure
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Créer les dossiers
|
|
||||||
mkdir -p docs archive/docs examples/{configuration,scripts,tests}
|
|
||||||
|
|
||||||
# Créer le README de l'archive
|
|
||||||
cat > archive/README.md << 'EOF'
|
|
||||||
# 📦 Archive - Documentation sdk_client
|
|
||||||
|
|
||||||
Ce dossier contient les anciens fichiers de documentation qui ont été migrés vers la nouvelle structure organisée.
|
|
||||||
|
|
||||||
## 📁 Contenu
|
|
||||||
|
|
||||||
- `docs/` - Anciens fichiers de documentation
|
|
||||||
- `README.md` - Ce fichier
|
|
||||||
|
|
||||||
## 🔗 Liens vers la Nouvelle Documentation
|
|
||||||
|
|
||||||
- **Documentation principale** : [../docs/INDEX.md](../docs/INDEX.md)
|
|
||||||
- **Guide d'installation** : [../docs/INSTALLATION.md](../docs/INSTALLATION.md)
|
|
||||||
- **Guide d'utilisation** : [../docs/USAGE.md](../docs/USAGE.md)
|
|
||||||
- **Guide de configuration** : [../docs/CONFIGURATION.md](../docs/CONFIGURATION.md)
|
|
||||||
- **Référence rapide** : [../docs/QUICK_REFERENCE.md](../docs/QUICK_REFERENCE.md)
|
|
||||||
|
|
||||||
## 📅 Date de Migration
|
|
||||||
|
|
||||||
Migration effectuée le : $(date)
|
|
||||||
EOF
|
|
||||||
```
|
|
||||||
|
|
||||||
### Étape 2 : Migrer les Fichiers
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Déplacer les fichiers vers l'archive
|
|
||||||
mv EXEMPLES_PRATIQUES.md archive/docs/
|
|
||||||
mv CONFIGURATION_DEV3.md archive/docs/
|
|
||||||
mv INTEGRATION_DEV3_FINAL.md archive/docs/
|
|
||||||
mv COMMANDES_REDEMARRAGE.md archive/docs/
|
|
||||||
mv RESUME_AJOUT_DEV3.md archive/docs/
|
|
||||||
mv RESUME_DECOUVERTE_NOEUDS.md archive/docs/
|
|
||||||
mv RESUME_SCRIPT_RESTART.md archive/docs/
|
|
||||||
mv RESUME_TEST_3_RELAIS.md archive/docs/
|
|
||||||
mv README_RESTART_SCRIPT.md archive/docs/
|
|
||||||
mv explain_node_discovery.md archive/docs/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Étape 3 : Fusionner les Spécifications
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Fusionner spec-technical.md dans spec-technique.md
|
|
||||||
cat specs/spec-technical.md >> specs/spec-technique.md
|
|
||||||
|
|
||||||
# Supprimer le fichier fusionné
|
|
||||||
rm specs/spec-technical.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Étape 4 : Créer les Guides Manquants
|
|
||||||
|
|
||||||
#### Créer `docs/ARCHITECTURE.md`
|
|
||||||
```bash
|
|
||||||
# Extraire les sections architecture de spec-technique.md
|
|
||||||
grep -A 50 "Architecture" specs/spec-technique.md > docs/ARCHITECTURE.md
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Créer `docs/EXTERNAL_NODES.md`
|
|
||||||
```bash
|
|
||||||
# Combiner les fichiers de configuration externe
|
|
||||||
cat archive/docs/CONFIGURATION_DEV3.md archive/docs/INTEGRATION_DEV3_FINAL.md archive/docs/RESUME_AJOUT_DEV3.md > docs/EXTERNAL_NODES.md
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Créer `docs/RELAY_NETWORK.md`
|
|
||||||
```bash
|
|
||||||
# Combiner les fichiers de réseau de relais
|
|
||||||
cat archive/docs/RESUME_DECOUVERTE_NOEUDS.md archive/docs/explain_node_discovery.md > docs/RELAY_NETWORK.md
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Créer `docs/SYNC_TESTING.md`
|
|
||||||
```bash
|
|
||||||
# Extraire les sections de test de synchronisation
|
|
||||||
cat archive/docs/RESUME_TEST_3_RELAIS.md > docs/SYNC_TESTING.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Étape 5 : Créer les Exemples
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Créer des exemples de configuration
|
|
||||||
cat > examples/configuration/bitcoin.conf.example << 'EOF'
|
|
||||||
# Exemple de configuration Bitcoin Core
|
|
||||||
signet=1
|
|
||||||
rpcuser=bitcoin
|
|
||||||
rpcpassword=your_secure_password
|
|
||||||
rpcbind=0.0.0.0
|
|
||||||
rpcallowip=172.19.0.0/16
|
|
||||||
zmqpubrawblock=tcp://0.0.0.0:29000
|
|
||||||
zmqpubrawtx=tcp://0.0.0.0:29000
|
|
||||||
txindex=1
|
|
||||||
server=1
|
|
||||||
listen=1
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Créer des exemples de scripts
|
|
||||||
cat > examples/scripts/monitor.sh << 'EOF'
|
|
||||||
#!/bin/bash
|
|
||||||
# Exemple de script de monitoring
|
|
||||||
while true; do
|
|
||||||
echo "=== $(date) ==="
|
|
||||||
docker ps --format "table {{.Names}}\t{{.Status}}"
|
|
||||||
sleep 30
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
chmod +x examples/scripts/monitor.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📋 Checklist de Migration
|
|
||||||
|
|
||||||
### ✅ Fichiers Créés
|
|
||||||
- [x] `docs/INDEX.md` - Index de documentation
|
|
||||||
- [x] `docs/INSTALLATION.md` - Guide d'installation
|
|
||||||
- [x] `docs/USAGE.md` - Guide d'utilisation
|
|
||||||
- [x] `docs/CONFIGURATION.md` - Guide de configuration
|
|
||||||
- [x] `docs/QUICK_REFERENCE.md` - Référence rapide
|
|
||||||
- [x] `docs/MIGRATION.md` - Ce guide de migration
|
|
||||||
|
|
||||||
### 🔄 Fichiers à Créer
|
|
||||||
- [ ] `docs/ARCHITECTURE.md` - Architecture technique
|
|
||||||
- [ ] `docs/API.md` - Référence API
|
|
||||||
- [ ] `docs/SECURITY.md` - Guide de sécurité
|
|
||||||
- [ ] `docs/PERFORMANCE.md` - Guide de performance
|
|
||||||
- [ ] `docs/TESTING.md` - Tests de base
|
|
||||||
- [ ] `docs/SYNC_TESTING.md` - Tests de synchronisation
|
|
||||||
- [ ] `docs/PERFORMANCE_TESTING.md` - Tests de performance
|
|
||||||
- [ ] `docs/RELAY_NETWORK.md` - Réseau de relais
|
|
||||||
- [ ] `docs/EXTERNAL_NODES.md` - Nœuds externes
|
|
||||||
- [ ] `docs/SYNCHRONIZATION.md` - Protocole de synchronisation
|
|
||||||
- [ ] `docs/TROUBLESHOOTING.md` - Guide de dépannage
|
|
||||||
- [ ] `docs/FAQ.md` - Questions fréquentes
|
|
||||||
|
|
||||||
### 🔄 Fichiers à Migrer
|
|
||||||
- [ ] `EXEMPLES_PRATIQUES.md` → `archive/docs/`
|
|
||||||
- [ ] `CONFIGURATION_DEV3.md` → `archive/docs/`
|
|
||||||
- [ ] `INTEGRATION_DEV3_FINAL.md` → `archive/docs/`
|
|
||||||
- [ ] `COMMANDES_REDEMARRAGE.md` → `archive/docs/`
|
|
||||||
- [ ] `RESUME_AJOUT_DEV3.md` → `archive/docs/`
|
|
||||||
- [ ] `RESUME_DECOUVERTE_NOEUDS.md` → `archive/docs/`
|
|
||||||
- [ ] `RESUME_SCRIPT_RESTART.md` → `archive/docs/`
|
|
||||||
- [ ] `RESUME_TEST_3_RELAIS.md` → `archive/docs/`
|
|
||||||
- [ ] `README_RESTART_SCRIPT.md` → `archive/docs/`
|
|
||||||
- [ ] `explain_node_discovery.md` → `archive/docs/`
|
|
||||||
|
|
||||||
### 🔄 Fichiers à Fusionner
|
|
||||||
- [ ] `specs/spec-technical.md` → `specs/spec-technique.md`
|
|
||||||
|
|
||||||
### 🔄 Dossiers à Créer
|
|
||||||
- [ ] `archive/` - Dossier d'archive
|
|
||||||
- [ ] `archive/docs/` - Anciens fichiers de documentation
|
|
||||||
- [ ] `examples/` - Exemples d'utilisation
|
|
||||||
- [ ] `examples/configuration/` - Exemples de configuration
|
|
||||||
- [ ] `examples/scripts/` - Scripts d'exemple
|
|
||||||
- [ ] `examples/tests/` - Tests d'exemple
|
|
||||||
|
|
||||||
## 🎯 Résultat Final
|
|
||||||
|
|
||||||
### Structure Finale
|
|
||||||
```
|
|
||||||
4NK_node/
|
|
||||||
├── README.md # Documentation principale
|
|
||||||
├── docs/ # Documentation organisée
|
|
||||||
│ ├── INDEX.md # Index de documentation
|
|
||||||
│ ├── INSTALLATION.md # Guide d'installation
|
|
||||||
│ ├── USAGE.md # Guide d'utilisation
|
|
||||||
│ ├── CONFIGURATION.md # Guide de configuration
|
|
||||||
│ ├── QUICK_REFERENCE.md # Référence rapide
|
|
||||||
│ ├── ARCHITECTURE.md # Architecture technique
|
|
||||||
│ ├── API.md # Référence API
|
|
||||||
│ ├── SECURITY.md # Guide de sécurité
|
|
||||||
│ ├── PERFORMANCE.md # Guide de performance
|
|
||||||
│ ├── TESTING.md # Tests de base
|
|
||||||
│ ├── SYNC_TESTING.md # Tests de synchronisation
|
|
||||||
│ ├── PERFORMANCE_TESTING.md # Tests de performance
|
|
||||||
│ ├── RELAY_NETWORK.md # Réseau de relais
|
|
||||||
│ ├── EXTERNAL_NODES.md # Nœuds externes
|
|
||||||
│ ├── SYNCHRONIZATION.md # Protocole de synchronisation
|
|
||||||
│ ├── TROUBLESHOOTING.md # Guide de dépannage
|
|
||||||
│ ├── FAQ.md # Questions fréquentes
|
|
||||||
│ └── MIGRATION.md # Guide de migration
|
|
||||||
├── specs/ # Spécifications techniques
|
|
||||||
│ ├── spec-technique.md # Spécification technique (fusionnée)
|
|
||||||
│ └── spec-fonctionnel.md # Spécification fonctionnelle
|
|
||||||
├── archive/ # Archive des anciens fichiers
|
|
||||||
│ ├── docs/ # Anciens fichiers de documentation
|
|
||||||
│ └── README.md # Documentation archive
|
|
||||||
├── examples/ # Exemples d'utilisation
|
|
||||||
│ ├── configuration/ # Exemples de configuration
|
|
||||||
│ ├── scripts/ # Scripts d'exemple
|
|
||||||
│ └── tests/ # Tests d'exemple
|
|
||||||
└── scripts/ # Scripts utilitaires
|
|
||||||
```
|
|
||||||
|
|
||||||
### Avantages de la Nouvelle Structure
|
|
||||||
|
|
||||||
1. **Organisation claire** : Documentation organisée par sujet
|
|
||||||
2. **Navigation facile** : Index centralisé avec liens
|
|
||||||
3. **Parcours d'apprentissage** : Guides adaptés au niveau d'expertise
|
|
||||||
4. **Maintenance simplifiée** : Structure modulaire
|
|
||||||
5. **Archive propre** : Anciens fichiers conservés mais séparés
|
|
||||||
6. **Exemples pratiques** : Exemples d'utilisation organisés
|
|
||||||
|
|
||||||
## 🔄 Commandes de Migration
|
|
||||||
|
|
||||||
### Migration Automatique
|
|
||||||
```bash
|
|
||||||
# Exécuter la migration complète
|
|
||||||
./migrate_documentation.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
### Migration Manuelle
|
|
||||||
```bash
|
|
||||||
# Créer la structure
|
|
||||||
mkdir -p docs archive/docs examples/{configuration,scripts,tests}
|
|
||||||
|
|
||||||
# Déplacer les fichiers
|
|
||||||
mv EXEMPLES_PRATIQUES.md archive/docs/
|
|
||||||
mv CONFIGURATION_DEV3.md archive/docs/
|
|
||||||
mv INTEGRATION_DEV3_FINAL.md archive/docs/
|
|
||||||
mv COMMANDES_REDEMARRAGE.md archive/docs/
|
|
||||||
mv RESUME_AJOUT_DEV3.md archive/docs/
|
|
||||||
mv RESUME_DECOUVERTE_NOEUDS.md archive/docs/
|
|
||||||
mv RESUME_SCRIPT_RESTART.md archive/docs/
|
|
||||||
mv RESUME_TEST_3_RELAIS.md archive/docs/
|
|
||||||
mv README_RESTART_SCRIPT.md archive/docs/
|
|
||||||
mv explain_node_discovery.md archive/docs/
|
|
||||||
|
|
||||||
# Fusionner les spécifications
|
|
||||||
cat specs/spec-technical.md >> specs/spec-technique.md
|
|
||||||
rm specs/spec-technical.md
|
|
||||||
|
|
||||||
# Créer le README de l'archive
|
|
||||||
cat > archive/README.md << 'EOF'
|
|
||||||
# 📦 Archive - Documentation sdk_client
|
|
||||||
|
|
||||||
Ce dossier contient les anciens fichiers de documentation qui ont été migrés vers la nouvelle structure organisée.
|
|
||||||
|
|
||||||
## 📁 Contenu
|
|
||||||
|
|
||||||
- `docs/` - Anciens fichiers de documentation
|
|
||||||
- `README.md` - Ce fichier
|
|
||||||
|
|
||||||
## 🔗 Liens vers la Nouvelle Documentation
|
|
||||||
|
|
||||||
- **Documentation principale** : [../docs/INDEX.md](../docs/INDEX.md)
|
|
||||||
- **Guide d'installation** : [../docs/INSTALLATION.md](../docs/INSTALLATION.md)
|
|
||||||
- **Guide d'utilisation** : [../docs/USAGE.md](../docs/USAGE.md)
|
|
||||||
- **Guide de configuration** : [../docs/CONFIGURATION.md](../docs/CONFIGURATION.md)
|
|
||||||
- **Référence rapide** : [../docs/QUICK_REFERENCE.md](../docs/QUICK_REFERENCE.md)
|
|
||||||
|
|
||||||
## 📅 Date de Migration
|
|
||||||
|
|
||||||
Migration effectuée le : $(date)
|
|
||||||
EOF
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**🔄 Migration de Documentation sdk_client - Structure organisée et maintenable !**
|
|
||||||
|
|
||||||
|
|
||||||
8
docs/templates/API.md
vendored
8
docs/templates/API.md
vendored
@ -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é
|
|
||||||
8
docs/templates/ARCHITECTURE.md
vendored
8
docs/templates/ARCHITECTURE.md
vendored
@ -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
|
|
||||||
6
docs/templates/CONFIGURATION.md
vendored
6
docs/templates/CONFIGURATION.md
vendored
@ -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)
|
|
||||||
12
docs/templates/INDEX.md
vendored
12
docs/templates/INDEX.md
vendored
@ -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
|
|
||||||
7
docs/templates/OPEN_SOURCE_CHECKLIST.md
vendored
7
docs/templates/OPEN_SOURCE_CHECKLIST.md
vendored
@ -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
|
|
||||||
29
docs/templates/README.md
vendored
29
docs/templates/README.md
vendored
@ -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)
|
|
||||||
7
docs/templates/RELEASE_PLAN.md
vendored
7
docs/templates/RELEASE_PLAN.md
vendored
@ -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)
|
|
||||||
7
docs/templates/SECURITY_AUDIT.md
vendored
7
docs/templates/SECURITY_AUDIT.md
vendored
@ -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)
|
|
||||||
6
docs/templates/TESTING.md
vendored
6
docs/templates/TESTING.md
vendored
@ -1,6 +0,0 @@
|
|||||||
# Tests — Template
|
|
||||||
|
|
||||||
- Pyramide: unit, integration, connectivity, external, performance
|
|
||||||
- Structure des répertoires
|
|
||||||
- Exécution et rapports
|
|
||||||
- Intégration CI
|
|
||||||
7
docs/templates/USAGE.md
vendored
7
docs/templates/USAGE.md
vendored
@ -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)
|
|
||||||
Loading…
x
Reference in New Issue
Block a user