4nk/story-research-zapwall
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
story-research-zapwall/features/documentation-plan.md
Nicolas Cantu cf5ebeb6e9 \
2025-12-23 02:20:57 +01:00

1.3 KiB
Raw Blame History

Documentation technique à compléter

Objectif

Formaliser la structure technique (services, hooks, types) et le flux Nostr/stockage, sans ajouter de tests ni d’analytics.

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 d’analytics.
  • Pas de fallback implicite; erreurs loguées et surfacées.
  • Respect lint/typage/accessibilité.