docs: normalisation titres H2 et DEPLOYMENT renseigné

2025-09-03 08:19:41 +00:00 · 2025-09-03 08:19:41 +00:00 · 0e7cc442b8
commit 0e7cc442b8
parent 58047e0077
5 changed files with 93 additions and 66 deletions
--- a/docs/API.md
+++ b/docs/API.md
@ -1,4 +1,4 @@
-# API - ihm_client
+## API - ihm_client

 Ce document décrit les interfaces publiques significatives exposées par l’interface `ihm_client`. Il ne contient aucun exemple d’usage exécutable et sert de référence de contrat.

--- a/docs/ARCHITECTURE.md
+++ b/docs/ARCHITECTURE.md
@ -1,4 +1,4 @@
-# 🏗️ Architecture Technique - ihm_client
+## 🏗️ Architecture Technique - ihm_client

 Documentation technique détaillée de l'architecture de l'interface utilisateur ihm_client.

@ -256,24 +256,24 @@ export default defineConfig({

 #### Développement
 ```bash
-# Serveur de développement
+## Serveur de développement
 npm run dev

-# Hot Module Replacement activé
-# Compilation TypeScript en temps réel
-# Chargement WASM à la demande
+## Hot Module Replacement activé
+## Compilation TypeScript en temps réel
+## Chargement WASM à la demande
 ```

 #### Production
 ```bash
-# Build optimisé
+## Build optimisé
 npm run build

-# Optimisations :
-# - Tree shaking
-# - Code splitting
-# - Minification
-# - Compression gzip
+## Optimisations :
+## - Tree shaking
+## - Code splitting
+## - Minification
+## - Compression gzip
 ```

 ### Optimisations
@ -419,7 +419,7 @@ impl SecureWallet {

 ##### Bundle Size
 ```bash
-# Taille des bundles
+## Taille des bundles
 dist/
 ├── index.js              # ~300 KB (gzippé)
 ├── sdk_client.wasm       # ~3.3 MB (gzippé)
@ -511,10 +511,10 @@ pub fn process_wallet() -> Result<Wallet, Error> {

 #### Développement
 ```bash
-# Serveur de développement
+## Serveur de développement
 npm run dev

-# Variables d'environnement
+## Variables d'environnement
 NODE_ENV=development
 VITE_API_URL=http://localhost:8091
 VITE_WS_URL=ws://localhost:8090
@ -522,10 +522,10 @@ VITE_WS_URL=ws://localhost:8090

 #### Production
 ```bash
-# Build de production
+## Build de production
 npm run build

-# Variables d'environnement
+## Variables d'environnement
 NODE_ENV=production
 VITE_API_URL=https://api.4nkweb.com
 VITE_WS_URL=wss://ws.4nkweb.com
@ -539,7 +539,7 @@ VITE_WS_URL=wss://ws.4nkweb.com

 #### Variables d'Environnement
 ```bash
-# Configuration pour 4NK_node
+## Configuration pour 4NK_node
 SDK_RELAY_WS_URL=ws://sdk_relay_1:8090
 SDK_RELAY_HTTP_URL=http://sdk_relay_1:8091
 BITCOIN_RPC_URL=http://bitcoin:18443
--- a/docs/DEPLOYMENT.md
+++ b/docs/DEPLOYMENT.md
@ -0,0 +1,27 @@
+## DEPLOYMENT
+
+### Docker
+- Image: construite via Dockerfile.4nk-node
+- Exposition: ports 80 et 3003
+- Healthcheck: HTTP sur http://localhost
+- Volumes: ihm_client_logs, ihm_client_data
+- Réseau Docker: btcnet (externe)
+
+### Intégration dans 4NK_node
+- Service déclaré dans docker-compose.4nk-node.yml
+- Dépendances: sdk_relay_1, sdk_relay_2, sdk_relay_3
+- Variables d’environnement (réseaux/services partagés):
+  - SDK_RELAY_WS_URL=ws://sdk_relay_1:8090
+  - SDK_RELAY_HTTP_URL=http://sdk_relay_1:8091
+  - BITCOIN_RPC_URL=http://bitcoin:18443
+  - BLINDBIT_URL=http://blindbit:8000
+
+### CI/CD appliquée
+- Build image sur branche docker-support-v2 (tag recommandé)
+- Vérifier la disponibilité des artefacts dist/ et la santé (healthcheck) avant publication
+
+### Configuration
+- Nginx livré dans l’image (nginx.4nk-node.conf)
+- Ports exposés: 80, 3003
+- Réseau: btcnet (externe)
+- Variables d’environnement listées plus haut
--- a/docs/SSH_USAGE.md
+++ b/docs/SSH_USAGE.md
@ -1,4 +1,4 @@
-# Documentation SSH complète - ihm_client
+## Documentation SSH complète - ihm_client

 ## Vue d'ensemble

@ -44,19 +44,19 @@ Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique :
 #### Options disponibles

 ```bash
-# Push rapide (message automatique)
+## Push rapide (message automatique)
 ./scripts/auto-ssh-push.sh quick

-# Push avec message personnalisé
+## Push avec message personnalisé
 ./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"

-# Push sur une branche spécifique
+## Push sur une branche spécifique
 ./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite

-# Push et merge (avec confirmation)
+## Push et merge (avec confirmation)
 ./scripts/auto-ssh-push.sh merge

-# Vérification du statut
+## Vérification du statut
 ./scripts/auto-ssh-push.sh status
 ```

@ -136,20 +136,20 @@ Le workflow CI/CD dans `.gitea/workflows/ci.yml` inclut une étape de configurat
 ### Alias configurés

 ```bash
-# Push rapide avec message automatique
+## Push rapide avec message automatique
 git quick-push

-# Push avec message personnalisé
+## Push avec message personnalisé
 git ssh-push "Mon message de commit"
 ```

 ### Configuration des alias

 ```bash
-# Alias pour push rapide
+## Alias pour push rapide
 git config --global alias.quick-push '!f() { git add . && git commit -m "Update $(date)" && git push origin $(git branch --show-current); }; f'

-# Alias pour push avec message
+## Alias pour push avec message
 git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto-commit $(date)}" && git push origin $(git branch --show-current); }; f'
 ```

@ -211,33 +211,33 @@ git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto
 #### 1. Échec d'authentification SSH

 ```bash
-# Vérifier la configuration SSH
+## Vérifier la configuration SSH
 ssh -T git@git.4nkweb.com

-# Vérifier les permissions
+## Vérifier les permissions
 ls -la ~/.ssh/

-# Régénérer la clé SSH si nécessaire
+## Régénérer la clé SSH si nécessaire
 ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk
 ```

 #### 2. Configuration Git incorrecte

 ```bash
-# Vérifier la configuration Git
+## Vérifier la configuration Git
 git config --global --list | grep url

-# Reconfigurer SSH
+## Reconfigurer SSH
 git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
 ```

 #### 3. Problèmes CI/CD

 ```bash
-# Vérifier les variables d'environnement
+## Vérifier les variables d'environnement
 echo $SSH_PRIVATE_KEY

-# Tester la configuration SSH
+## Tester la configuration SSH
 ./scripts/setup-ssh-ci.sh
 ```

@ -250,10 +250,10 @@ echo $SSH_PRIVATE_KEY
 ### Logs et debugging

 ```bash
-# Activer le debug SSH
+## Activer le debug SSH
 ssh -vT git@git.4nkweb.com

-# Vérifier les logs Git
+## Vérifier les logs Git
 GIT_SSH_COMMAND="ssh -v" git push origin main
 ```

@ -273,10 +273,10 @@ Le projet `ihm_client` est configuré pour s'intégrer dans l'infrastructure `4N
 ### Workflow d'intégration

 ```bash
-# Intégrer ihm_client dans 4NK_node
+## Intégrer ihm_client dans 4NK_node
 ./scripts/integrate-4nk-node.sh

-# Vérifier l'intégration
+## Vérifier l'intégration
 docker-compose -f docker-compose.4nk-node.yml up -d
 ```

--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@ -1,4 +1,4 @@
-# 📖 Guide d'Utilisation - ihm_client
+## 📖 Guide d'Utilisation - ihm_client

 Guide complet pour utiliser l'interface utilisateur ihm_client au quotidien.

@ -7,11 +7,11 @@ Guide complet pour utiliser l'interface utilisateur ihm_client au quotidien.
 ### Démarrage du Serveur de Développement

 ```bash
-# Démarrer le serveur de développement
+## Démarrer le serveur de développement
 npm run dev

-# Le serveur démarre sur http://localhost:3000
-# Hot reload activé pour le développement
+## Le serveur démarre sur http://localhost:3000
+## Hot reload activé pour le développement
 ```

 ### Accès à l'Interface
@ -52,28 +52,28 @@ npm run dev

 ##### Export User Data
 ```bash
-# Génère un fichier JSON avec toutes les données utilisateur
-# Inclut : profil, processus, documents, wallet
+## Génère un fichier JSON avec toutes les données utilisateur
+## Inclut : profil, processus, documents, wallet
 ```

 ##### Export Recovery
 ```bash
-# Génère les 4 mots de récupération
-# IMPORTANT : Noter et conserver en lieu sûr
-# Le bouton devient inaccessible après utilisation
+## Génère les 4 mots de récupération
+## IMPORTANT : Noter et conserver en lieu sûr
+## Le bouton devient inaccessible après utilisation
 ```

 ##### Delete Account
 ```bash
-# Supprime définitivement le compte
-# Demande de confirmation obligatoire
-# Action irréversible
+## Supprime définitivement le compte
+## Demande de confirmation obligatoire
+## Action irréversible
 ```

 ##### Logout
 ```bash
-# Déconnexion de l'interface
-# Retour à la page de connexion
+## Déconnexion de l'interface
+## Retour à la page de connexion
 ```

 ### Onglet Pairing
@ -105,13 +105,13 @@ npm run dev

 #### Opérations Wallet
 ```bash
-# Générer un nouveau wallet
+## Générer un nouveau wallet
 generate_sp_wallet()

-# Verrouiller des UTXOs
+## Verrouiller des UTXOs
 lock_freezed_utxos(wallet, utxos)

-# Scanner des blocs
+## Scanner des blocs
 scan_blocks(wallet, blocks)
 ```

@ -338,13 +338,13 @@ scan_blocks(wallet, blocks)

 #### Exporter des Données
 ```bash
-# Export complet du profil
+## Export complet du profil
 Export User Data > JSON

-# Export des processus
+## Export des processus
 Processus > Exporter > CSV

-# Export des documents
+## Export des documents
 Documents > Exporter > ZIP
 ```

@ -359,31 +359,31 @@ Documents > Exporter > ZIP

 #### Interface ne se charge pas
 ```bash
-# Vérifier le serveur
+## Vérifier le serveur
 npm run dev

-# Vérifier les logs
+## Vérifier les logs
 npm run dev --verbose

-# Nettoyer le cache
+## Nettoyer le cache
 npm run clean
 ```

 #### Module WASM non trouvé
 ```bash
-# Recompiler le module WASM
+## Recompiler le module WASM
 ./scripts/setup-remote-deps.sh

-# Vérifier le fichier
+## Vérifier le fichier
 ls -la pkg/sdk_client_bg.wasm
 ```

 #### Erreurs de connexion
 ```bash
-# Vérifier les variables d'environnement
+## Vérifier les variables d'environnement
 cat .env

-# Tester la connectivité
+## Tester la connectivité
 npm run test:connectivity
 ```