Skip to content

dx: xstreamroll-sdk README contains placeholder URLs and unimplemented features #395

Description

@Xhristin3

Problem Statement
xstreamroll-sdk/README.md references API endpoints and features (WebSocket subscriptions, paginateStreams()) that either do not exist in the current API or are not implemented in the SDK. New adopters following the README will encounter immediate failures.

Why It Matters
Documentation that doesn't match the implementation actively harms adoption.

Acceptance Criteria

  • Full audit of xstreamroll-sdk/README.md against the actual SDK implementation
  • Methods that don't exist marked clearly as (coming soon) or removed
  • A working 'Quick Start' code example tested against the real API
  • API compatibility table showing which SDK version works with which API version
  • Auto-generate API reference from TSDoc comments using typedoc

Files Affected: xstreamroll-sdk/README.md, xstreamroll-sdk/src/

Difficulty: Easy | Effort: 1 day

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationImprovements or additions to documentationdxsdkRelated to xstreamroll-sdk/

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions