[BUG]: `stablepay-sdk` README documents an unrelated thirdweb app instead of the actual SDK API

Aperta
#102 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Read stablepay-sdk/README.md alongside the package API in stablepay-sdk/src/ to identify the SDK's actual configuration, widget usage, supported flows, and transaction callbacks. Replace the unrelated thirdweb and Supabase app documentation with accurate StablePay SDK guidance; done when the README describes the API and setup that the source supports. The issue has no discussion or linked pull request, but it was opened 198 days ago.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug
Bug Description

The stablepay-sdk/README.md file currently starts as StablePay SDK documentation, but the actual body documents a completely different thirdweb + Supabase application rather than the widget SDK that exists in this repository.

This creates a real integration problem for contributors and consumers because the published package docs do not explain the actual SDK API, configuration shape, widget usage, or supported flows.

Why this is a problem:

  • package consumers get incorrect setup instructions
  • the README does not document Config, NetworkSelector, Widget, or transaction callbacks
  • the docs point users toward unrelated technologies and architecture
Steps to Reproduce
  1. Open stablepay-sdk/README.md
  2. Read the title and opening lines, which suggest this is SDK documentation
  3. Continue reading the body
  4. Observe that the content documents a separate thirdweb/Supabase app, including unrelated stack details, APIs, authentication flow, and app architecture
Logs and Screenshots

No runtime logs apply.

The issue is a documentation mismatch in source control:

  • the README file under stablepay-sdk/ does not match the code and package API in stablepay-sdk/src/
Environment Details
  • Area: stablepay-sdk
  • File: stablepay-sdk/README.md
  • Reproducible from current source checkout on March 27, 2026
  • Affects contributors and integrators reading package documentation
Impact

Low - Minor inconvenience

Code of Conduct
  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates
Lingua principale
JavaScript
Stelle
16
Fork
29
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di StabilityNexus/StablePay

Tutte le issue di StabilityNexus/StablePay

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.