story-research-zapwall/features/documentation-plan.md
2025-12-23 02:20:57 +01:00

25 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Documentation technique à compléter
## Objectif
Formaliser la structure technique (services, hooks, types) et le flux Nostr/stockage, sans ajouter de tests ni danalytics.
## Cibles
- Services Nostr : `lib/nostr.ts`, `lib/nostrRemoteSigner.ts`, `lib/articleMutations.ts`, `lib/zapVerification.ts`, `lib/nostrconnect.ts`.
- Paiement/Alby/WebLN : `lib/alby.ts`, `lib/payment.ts`, `lib/paymentPolling.ts`.
- Stockage : `lib/storage/indexedDB.ts`, `lib/storage/cryptoHelpers.ts`, `lib/articleStorage.ts`.
- Hooks : `hooks/useArticles.ts`, `hooks/useUserArticles.ts`, `hooks/useArticleEditing.ts`.
- Types : `types/nostr.ts`, `types/nostr-tools-extended.ts`, `types/alby.ts`.
- UI clés : `components/UserArticles*.tsx`, `components/ArticleEditor*.tsx`, `components/AlbyInstaller.tsx`.
## Plan
1) Cartographie des services/hooks/types (diagramme ou tableau : responsabilités, entrées/sorties, dépendances).
2) Guide Nostr : publication, update/delete, zap verification, remote signer.
3) Guide stockage : chiffrement IndexedDB, gestion des expirations.
4) Guide paiements : création facture, polling, envoi contenu privé.
5) Contrib : référencer dans `CONTRIBUTING.md`.
## Contraintes
- Pas de tests, pas danalytics.
- Pas de fallback implicite; erreurs loguées et surfacées.
- Respect lint/typage/accessibilité.