Skip to content

Improve SDK developer onboarding and integration flow #20

Description

@aguilar1x

Context

Developers should be able to go from discovering the SDK to rendering a working widget in minutes. This issue focuses on the developer experience needed to make adoption frictionless: clear onboarding, reliable API discovery, and a way to test the widget before integrating it.

Scope

  • Build a developer site using Nextra/Next.js.
  • Add a quickstart that gets a developer to a working integration quickly.
  • Generate the API reference directly from the SDK types so it stays aligned with the code.
  • Add an interactive playground where developers can configure the widget, preview it live using pk_test, and copy the generated integration snippet.

Acceptance criteria

  • A developer can follow the quickstart and render the widget without additional context.
  • The copied snippet works when pasted as-is.
  • The API reference is regenerated in CI whenever SDK types change.
  • The playground renders the widget in test mode and outputs a valid snippet.

Dependencies

Depends on #13, #15, and #19.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official Campaign

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions