[BUG]: Missing SDK API documentation and incomplete developer-facing usage guide in StablePay README

オープン
#104 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript
領域
documentation

調査の方向性

Start with stablepay-sdk/README.md and inspect the SDK entry exports and stablepay-sdk/src/widget/* to identify the public API and supported options. Then document installation, a minimal integration, and the listed components and transaction callbacks; done means the README lets a developer understand how to consume the SDK without treating internal files as its API.

索引モデルが issue の本文から書いたものです。

説明

bug
Bug Description

The current stablepay-sdk README provides a high-level overview of the StablePay widget architecture and clearly documents internal file structure (Widget, PayButton, NetworkDropdown, etc.).
However, it does not provide a proper SDK-level API reference or integration guide for developers using the package.

While the README explains what files exist, it does not explain:
*What the actual public SDK API is
*How developers are expected to import and use StablePay in a project
*What configuration options are available
*What events, callbacks, or props are supported
*Which parts of stablepay-sdk/src are public vs internal implementation
As a result, the README functions more like a codebase overview, not SDK documentation.

Why is this a problem?
This creates confusion for developers and integrators because:
*There is no clear “Getting Started” usage example
*No documented entry point (index exports or SDK initialization flow)
*No explanation of how to use:
->Widget
->PayButton
->network selection flow
->transaction lifecycle callbacks
*Developers must manually inspect the source code to understand usage
*Internal components are documented, but not how to actually consume the SDK
This increases onboarding time and reduces SDK usability.

Steps to Reproduce

Steps to Reproduce

  1. In stablepay-sdk/README.md
  2. In the “Code Structure Overview” section
  3. Look for:
    ->installation instructions
    ->import examples
    ->SDK usage snippets
    ->configuration API
  4. Notice that none of the above exist
  5. Compare with actual code in stablepay-sdk/src and entry exports
  6. Observe missing developer-facing API documentation

Affected Area
->Package: stablepay-sdk
->File: stablepay-sdk/README.md
->Source: stablepay-sdk/src/widget/* and SDK entry exports

Expected Behavior
The README should include a proper SDK documentation section such as:
*Installation guide (npm/yarn/pnpm)
*Basic usage example (minimum working widget integration)
*Public API reference:
->Widget
->PayButton
->NetworkDropdown
->TokenDropdown
->transaction callbacks/events
*Configuration options (props, network config, payment settings)
*Example integration flow (merchant checkout use case)
*Clear distinction between:
*public SDK exports
*internal implementation files

Actual Behavior
The README currently:
*Focuses on repository structure instead of SDK usage
*Lists internal widget file breakdown
*Does not explain how to actually integrate or use StablePay in a project
*Lacks API reference or developer onboarding guide

Logs and Screenshots

No logs apply.

Environment Details

->Area: stablepay-sdk
->File: README.md
->Repro: As of Mar 27, 2026
->Impact: SDK users and maintainers

Impact

Medium - Feature works but has issues

Code of Conduct
  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates
主要言語
JavaScript
スター
16
フォーク
29
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

StabilityNexus/StablePay のほかの issue

StabilityNexus/StablePay の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。