4NK_dev/docs/documentation_cleanup_plan.md

Plan de Nettoyage de la Documentation

📋 Analyse des Problèmes Identifiés

🔴 Problèmes Critiques

1. sdk_common/docs/

• API.md : Contient des APIs Bitcoin Core et Blindbit qui ne sont pas liées à sdk_common
• USAGE.md : Références à des features WASM et npm qui n'existent pas
• INDEX.md : Références à des fichiers qui n'existent pas (QUICK_REFERENCE.md, MIGRATION.md)

2. sdk_client/docs/

• MIGRATION.md : Fait référence à 4NK_node au lieu de sdk_client
• INDEX.md : Références à des fichiers inexistants
• API.md : Probablement obsolète avec le stub WASM actuel

3. sdk_signer/docs/

• INDEX.md : Template générique non personnalisé
• docker-support.md : Documentation correcte mais pourrait être améliorée

4. sdk_storage/docs/

• README.md : Documentation correcte mais fragmentée
• api_json_spec.md : Documentation technique correcte

🎯 Plan de Nettoyage

Phase 1 : Nettoyage Critique (Priorité 1)

sdk_common/docs/

# Fichiers à corriger
- API.md → Supprimer ou corriger pour sdk_common uniquement
- USAGE.md → Corriger les références WASM/npm inexistantes
- INDEX.md → Mettre à jour les liens vers les fichiers existants
- ARCHITECTURE.md → Vérifier la cohérence avec l'état actuel

sdk_client/docs/

# Fichiers à corriger
- MIGRATION.md → Supprimer ou corriger pour sdk_client
- INDEX.md → Mettre à jour les liens
- API.md → Adapter pour le stub WASM actuel

Phase 2 : Amélioration (Priorité 2)

sdk_signer/docs/

# Fichiers à améliorer
- INDEX.md → Personnaliser pour sdk_signer
- docker-support.md → Intégrer dans INDEX.md
- Créer une documentation complète

sdk_storage/docs/

# Fichiers à consolider
- README.md → Garder, bien structuré
- api_json_spec.md → Garder, documentation technique correcte
- Consolider les autres fichiers fragmentés

🔧 Actions Spécifiques

1. sdk_common/docs/

Supprimer/Corriger API.md

# Remplacer par une vraie API de sdk_common
- Types et structures
- Fonctions utilitaires
- Exemples d'utilisation
- Pas d'APIs Bitcoin Core

Corriger USAGE.md

# Supprimer les références inexistantes
- Supprimer "npm install @4nk/sdk-common"
- Supprimer les features WASM inexistantes
- Garder uniquement l'utilisation Rust

Mettre à jour INDEX.md

# Corriger les liens
- Supprimer les références vers QUICK_REFERENCE.md
- Supprimer les références vers MIGRATION.md
- Garder uniquement les fichiers existants

2. sdk_client/docs/

Supprimer MIGRATION.md

# Ce fichier fait référence à 4NK_node
# Supprimer ou corriger complètement

Corriger INDEX.md

# Mettre à jour pour refléter l'état actuel
- Stub WASM temporaire
- Migration flate2 en cours
- Pas de compilation WASM complète

3. sdk_signer/docs/

Personnaliser INDEX.md

# Créer une vraie documentation sdk_signer
- Services fournis
- Compatibilité WASM
- Configuration TypeScript
- Tests et développement

4. sdk_storage/docs/

Consolider la documentation

# Garder la structure actuelle
- README.md est correct
- api_json_spec.md est correct
- Consolider les fichiers fragmentés

📊 État Final Cible

Documentation Propre et Cohérente

sdk_common/docs/

• ✅ API.md : APIs réelles de sdk_common uniquement
• ✅ USAGE.md : Utilisation Rust uniquement
• ✅ INDEX.md : Liens corrects vers fichiers existants
• ✅ ARCHITECTURE.md : Cohérent avec l'état actuel

sdk_client/docs/

• ✅ MIGRATION.md : Supprimé ou corrigé
• ✅ INDEX.md : Reflète l'état du stub WASM
• ✅ API.md : Documentation du stub WASM

sdk_signer/docs/

• ✅ INDEX.md : Documentation personnalisée complète
• ✅ docker-support.md : Intégré dans la documentation principale

sdk_storage/docs/

• ✅ README.md : Gardé tel quel (correct)
• ✅ api_json_spec.md : Gardé tel quel (correct)
• ✅ Autres fichiers : Consolidés si nécessaire

🚀 Implémentation

Ordre d'exécution

1. sdk_common/docs/ - Nettoyage critique
2. sdk_client/docs/ - Nettoyage critique
3. sdk_signer/docs/ - Amélioration
4. sdk_storage/docs/ - Consolidation

Validation

• Vérifier que tous les liens fonctionnent
• S'assurer que la documentation reflète l'état actuel
• Tester la cohérence entre les projets
• Valider avec les développeurs

📝 Notes

• Préserver : Documentation technique correcte (api_json_spec.md, docker-support.md)
• Corriger : Documentation avec références incorrectes
• Supprimer : Documentation obsolète ou incorrecte
• Créer : Documentation manquante pour sdk_signer