# 📚 Index de Documentation - sdk_common Index complet de la documentation de la bibliothèque commune sdk_common pour les Silent Payments. ## 📖 Guides Principaux ### 🚀 [Guide d'Installation](INSTALLATION.md) Guide complet pour installer et configurer la bibliothèque sdk_common. - **Prérequis système et logiciels** - **Installation de Rust et dépendances** - **Configuration Cargo et features** - **Tests post-installation** - **Dépannage et monitoring** ### 📖 [Guide d'Utilisation](USAGE.md) Guide complet pour utiliser la bibliothèque sdk_common au quotidien. - **Compilation et build** - **Intégration dans les projets** - **Utilisation des types et structures** - **Tests et validation** - **Configuration et maintenance** - **Optimisations de performance** ### ⚙️ [Guide de Configuration](CONFIGURATION.md) Guide complet pour configurer la bibliothèque selon vos besoins. - **Configuration générale et variables d'environnement** - **Configuration Rust et Cargo** - **Configuration des features** - **Configuration de build** - **Configuration de tests** - **Configuration de sécurité** ## 🔧 Guides Techniques ### 🏗️ [Architecture Technique](ARCHITECTURE.md) Documentation technique détaillée de l'architecture. - **Architecture générale de la bibliothèque** - **Composants principaux (types, structures, traits)** - **Architecture des Silent Payments** - **Flux de données et types** - **Intégration avec sdk_client et sdk_relay** - **Sécurité et isolation** - **Performance et optimisations** - **Monitoring et observabilité** ### 📡 [API Reference](API.md) Documentation complète des APIs disponibles. - **Types et structures de données** - **Fonctions utilitaires** - **Traits et interfaces** - **Gestion des erreurs** - **Exemples d'utilisation** - **Performance et sécurité** ### 🔒 [Sécurité](SECURITY.md) Guide de sécurité et bonnes pratiques. - **Authentification et autorisation** - **Chiffrement et certificats** - **Sécurité des types et structures** - **Audit et monitoring de sécurité** - **Bonnes pratiques** ### 🐙 [Configuration Gitea](GITEA_SETUP.md) Guide de configuration spécifique pour Gitea. - **Configuration du repository Gitea** - **Templates d'issues et pull requests** - **Configuration CI/CD avec Gitea Actions** - **Intégrations et webhooks** - **Workflow de contribution** - **Sécurité et permissions** ### 🚀 [Plan de Release](RELEASE_PLAN.md) Plan de lancement open source complet. - **Phases de préparation** - **Communication et marketing** - **Checklist de lancement** - **Support communautaire** - **Gestion des risques** ### 🌟 [Guide de la Communauté](COMMUNITY_GUIDE.md) Guide complet pour la communauté. - **Comment contribuer** - **Ressources d'apprentissage** - **Environnement de développement** - **Processus de contribution** - **Support et reconnaissance** ### 🗺️ [Roadmap](ROADMAP.md) Roadmap de développement détaillée. - **Timeline de développement** - **Fonctionnalités planifiées** - **Évolution de l'architecture** - **Métriques de succès** ## 🧪 Guides de Test ### 🧪 [Guide des Tests](TESTING.md) Guide complet pour les tests de la bibliothèque. - **Tests unitaires Rust** - **Tests d'intégration** - **Tests de performance** - **Tests de sécurité** - **Tests de compatibilité** - **Tests de régression** ### 🔍 [Audit de Sécurité](SECURITY_AUDIT.md) Audit de sécurité détaillé. - **Vulnérabilités connues** - **Tests de pénétration** - **Audit de code** - **Recommandations de sécurité** - **Plan de remédiation** ## 🔧 Guides de Développement ### 🔧 [Guide de Développement](DEVELOPMENT.md) Guide complet pour le développement. - **Environnement de développement** - **Workflow de développement** - **Standards de code** - **Debugging et profiling** - **Optimisation des performances** - **Déploiement et CI/CD** ## 🌐 Guides d'Intégration ### 🔑 [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é](SSH_USAGE.md) Guide pour l'automatisation des pushes SSH. - **Configuration des scripts** - **Intégration CI/CD** - **Gestion des clés** - **Sécurité et bonnes pratiques** ## 🔧 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** --- ## 🎯 Navigation Rapide ### 🚀 Démarrage Rapide 1. [Installation](INSTALLATION.md) - Installer sdk_common 2. [Configuration](CONFIGURATION.md) - Configurer l'environnement 3. [Utilisation](USAGE.md) - Utiliser la bibliothèque ### 🔧 Développement 1. [Architecture](ARCHITECTURE.md) - Comprendre l'architecture 2. [API](API.md) - Consulter les APIs 3. [Tests](TESTING.md) - Exécuter les tests ### 📚 Documentation 1. [Index](INDEX.md) - Cet index 2. [Roadmap](ROADMAP.md) - Évolution du projet ### 🤝 Communauté 1. [Guide Communauté](COMMUNITY_GUIDE.md) - Contribuer 2. [Code de Conduite](../CODE_OF_CONDUCT.md) - Règles de conduite 3. [Support](SUPPORT.md) - Obtenir de l'aide --- ## 🧪 Tests et Validation ### Tests Automatisés ```bash # Tests unitaires cargo test --all # Tests d'intégration cargo test --test integration # Tests de performance cargo test --test performance # Linting cargo clippy -- -D warnings # Formatage cargo fmt -- --check ``` ### Tests de Compatibilité ```bash # Tests de compatibilité avec sdk_client cargo test --features sdk-client # Tests de compatibilité avec sdk_relay cargo test --features sdk-relay ``` --- ## 🚀 Développement ### Commandes Essentielles ```bash # Build de développement cargo build # Build de production cargo build --release # Tests cargo test --all # Documentation cargo doc --open ``` --- **📚 Documentation complète pour sdk_common - Bibliothèque commune pour les Silent Payments** 🚀