Skip to content

docs: fix misleading Rokt SDK README integration guides - #295

Merged
thomson-t merged 1 commit into
mainfrom
docs/sdk-readme-audit
Aug 19, 2026
Merged

thomson-t merged 1 commit into
mainfrom
docs/sdk-readme-audit

Conversation

@thomson-t

@thomson-t thomson-t commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

Background

  • A partner engineer called Rokt.purchaseFinalized(...) on their order-confirmation page, assuming it reports a normal checkout. It does not — it closes the loop on a Rokt in-placement instant purchase (Shoppable Ads). The docs made that easy to misread, and several other claims across the two README files were outdated, wrong, or misleading (the removed execute() API, a fabricated Ruby version, a dead M1 workaround, a renamed payment-extension class).

What Has Changed

  • README.md (canonical guide): rewrote the Purchase Finalized section and API-table row so it clearly states it is for Rokt in-placement instant purchases only — called from the CartItemInstantPurchase event handler using that event's placementId/catalogItemId — with an explicit "not for normal checkout / order-confirmation" warning. Renamed the payment extension to RoktPaymentExtension; replaced pk_live_... with a placeholder. Corrected "Rokt SDK 5.0" → "5.x".
  • Rokt.Widget/src/Rokt.tsx: added JSDoc to purchaseFinalized, initialize, and selectPlacements so the guidance/warning surfaces on IDE hover and in the shipped .d.ts (root cause: the method had no JSDoc, so the partner's editor showed nothing).
  • Rokt.Widget/README.md (the npm-published README): full rewrite to a concise, correct package README — removed the execute() API (removed in v5), the fabricated Ruby 2.7.6 requirement, and the dead M1 brew uninstall/EXCLUDED_ARCHS=arm64 block; links to the canonical repo guide plus the official React Native and CocoaPods setup docs.
  • MIGRATING.md + iOS sample (AppDelegate.swift, Podfile): renamed RoktStripePaymentExtension → RoktPaymentExtension.
  • Deliberately left intact the "Android Shoppable Ads is a no-op" note — verified the RN Android bridge genuinely no-ops (RNRoktWidgetModuleImpl.kt), so the statement is correct for the RN SDK.

Screenshots/Video

  • {Leave for author}

Checklist

  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have tested this locally.

Additional Notes

  • Every version/API/packaging claim was verified against the SDK source, the native iOS (munich-v2) and Android (sydney) SDKs, the sample apps, and CI config — not assumed.
  • Out-of-scope follow-ups: RoktSampleApp/README.md "Node.js (v14+)" (real min ≥18, CI 20); iOS pod major (5.x) vs Android com.rokt:roktsdk:6.0.2 mismatch.

Reference Issue

  • N/A — no associated ticket.

🤖 Generated with Claude Code

@thomson-t
thomson-t requested a review from a team as a code owner August 17, 2026 13:36

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

Tip: disable this comment in your organization's Code Review settings.

@pr-security-agent

pr-security-agent Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

🔒 Security Scan Complete

✅ No security issues detected

Scanned files against 91 rules. · Reviewed commit: 01b27bc230

📜 Scan history (2 scans)
Commit Time (UTC) Status Findings
01b27bc 2026-08-19 14:49:22 ✅ success 0
605b1fc 2026-08-17 13:41:35 ✅ success 0
ℹ️ About PR Security Agent

This scan was performed by PR Security Agent, an automated security review tool for pull requests. See the User Guide for details on severity levels, feedback reactions, and scan configuration.

Reply @pr-security-agent help for the list of commands you can run on this PR.

@paved-road-agent

paved-road-agent Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

🛣️ ROKT Data Platform Paved Roads Scan Complete

✅ No paved-road issues detected

Scanned files against 2 rules. · Reviewed commit: 01b27bc230

📜 Scan history (2 scans)
Commit Time (UTC) Status Findings
01b27bc 2026-08-19 14:49:21 ✅ success 0
605b1fc 2026-08-17 13:41:36 ✅ success 0
ℹ️ About ROKT Data Platform Paved Roads Agent

This scan was performed by the ROKT Data Platform Paved Roads Agent, an automated paved-road standards review tool for pull requests. See the User Guide for details on severity levels, feedback reactions, and scan configuration.

Reply @paved-road-agent help for the list of commands you can run on this PR.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 605b1fc543

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread MIGRATING.md Resolved
- Clarify purchaseFinalized: it closes the loop on a Rokt in-placement
  instant purchase (Shoppable Ads), NOT a checkout/order-confirmation hook.
  Rewrote the README section + API table and added JSDoc so the warning
  surfaces on IDE hover at the call site.
- Rewrite Rokt.Widget/README.md (the npm-published README): drop the removed
  execute() API, the fabricated Ruby 2.7.6 requirement, and the dead M1 arm64
  workaround; link to the canonical repo guide + official RN/CocoaPods docs.
- Rename payment extension RoktStripePaymentExtension -> RoktPaymentExtension
  across README, MIGRATING.md, and the iOS sample (AppDelegate + Podfile).

Every claim verified against SDK source, native iOS/Android SDKs, sample apps,
and CI (versions, API surface, packaging).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@thomson-t
thomson-t force-pushed the docs/sdk-readme-audit branch from 605b1fc to 01b27bc Compare August 19, 2026 14:49
@thomson-t
thomson-t merged commit e588477 into main Aug 19, 2026
10 checks passed
@thomson-t
thomson-t deleted the docs/sdk-readme-audit branch August 19, 2026 15:53
@rokt-releases rokt-releases Bot mentioned this pull request Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants