252 lines
6.4 KiB
Markdown
252 lines
6.4 KiB
Markdown
# 📚 Index de Documentation - sdk_client
|
||
|
||
Index complet de la documentation du SDK client pour les Silent Payments.
|
||
|
||
## 📖 Guides Principaux
|
||
|
||
### 🚀 [Guide d'Installation](INSTALLATION.md)
|
||
Guide complet pour installer et configurer le SDK client.
|
||
- Prérequis système et logiciels
|
||
- Installation de Rust et dépendances
|
||
- Configuration WASM et compilation
|
||
- Tests post-installation
|
||
- Dépannage et monitoring
|
||
|
||
### 📖 [Guide d'utilisation](USAGE.md)
|
||
Parcours d’utilisation, intégration et validations (sans exemples exécutables).
|
||
|
||
### ⚙️ [Guide de Configuration](CONFIGURATION.md)
|
||
Guide complet pour configurer le SDK selon vos besoins.
|
||
- Configuration générale et variables d'environnement
|
||
- Configuration Rust et Cargo
|
||
- Configuration WASM et wasm-pack
|
||
- 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 du SDK
|
||
- Composants principaux (Rust, WASM, JavaScript)
|
||
- Architecture des Silent Payments
|
||
- Flux de données et types
|
||
- Intégration avec sdk_common
|
||
- Sécurité et isolation
|
||
- Performance et optimisations
|
||
- Monitoring et observabilité
|
||
|
||
### 📡 [Référence API](API.md)
|
||
Contrats publics WASM/Rust, structures, erreurs, invariants et limites.
|
||
|
||
### 🔒 Sécurité
|
||
Bonnes pratiques et audit: voir `SECURITY_AUDIT.md`.
|
||
|
||
### 🐙 [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)
|
||
- Tests unitaires et intégration (cargo)
|
||
- Tests WASM (Windows): script `scripts/run-wasm-tests.ps1` (LLVM/Clang requis, runner wasm-bindgen)
|
||
|
||
#### Commandes utiles
|
||
```bash
|
||
# Tests natifs
|
||
cargo test
|
||
```
|
||
|
||
Pour les tests WASM, se référer au script PowerShell (voir détails dans `docs/TESTING.md`).
|
||
|
||
### 🔍 [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
|
||
|
||
### 🔧 Développement
|
||
Références réparties entre `ARCHITECTURE.md`, `API.md`, `TESTING.md`.
|
||
|
||
### 📋 [Référence Rapide](QUICK_REFERENCE.md)
|
||
Référence rapide pour les développeurs.
|
||
- **Commandes essentielles**
|
||
- **Structure du projet**
|
||
- **APIs principales**
|
||
- **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**
|
||
|
||
## 🌐 Guides d'Intégration
|
||
|
||
### 🔗 Intégrations externes
|
||
Références hors périmètre dans les dépôts d’infrastructure.
|
||
|
||
### 🔑 [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_client.
|
||
- **Statut des compilations**
|
||
- **Configuration des branches**
|
||
- **Fonctionnalités opérationnelles**
|
||
- **Métriques de performance**
|
||
- **Problèmes connus**
|
||
|
||
### 📋 Résumé final
|
||
Récapitulatif si applicable.
|
||
|
||
## 🔧 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_client
|
||
2. [Configuration](CONFIGURATION.md) - Configurer l'environnement
|
||
3. [Utilisation](USAGE.md) - Utiliser le SDK
|
||
|
||
### 🔧 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. [Quick Reference](QUICK_REFERENCE.md) - Référence rapide
|
||
3. [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 WASM
|
||
```bash
|
||
# Compilation WASM
|
||
wasm-pack build --target web
|
||
|
||
# Tests WASM
|
||
wasm-pack test --headless --firefox
|
||
wasm-pack test --headless --chrome
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 Développement
|
||
|
||
### Commandes Essentielles
|
||
```bash
|
||
# Build de développement
|
||
cargo build
|
||
|
||
# Build de production
|
||
cargo build --release
|
||
|
||
# Compilation WASM
|
||
wasm-pack build --target web
|
||
|
||
# Tests
|
||
cargo test --all
|
||
```
|
||
|
||
---
|
||
|
||
**📚 Documentation complète pour sdk_client — SDK client pour les Silent Payments** 🚀
|