update-sdk-docs

name	update-sdk-docs
description	Update Superwall SDK docs to a new released version for ios, android, flutter, expo, or react-native. Use when asked to sync docs with an SDK release, bump SDK version docs, or run the update-sdk-docs workflow. Handles reference sync, upstream tag diffing, changelog updates, docs edits, verification, and PR prep.

Update SDK Docs

Required Inputs

1. sdk: one of ios, android, flutter, expo, react-native.
2. newVersion: semantic version like 4.13.0.

Workflow

1. Prep and validation

• Run bun run download:references.
• Set:
  • overviewPath = content/docs/<sdk>/index.mdx
  • referenceOverviewPath = content/docs/<sdk>/sdk-reference/index.mdx
• Parse <SdkLatestVersion version="..."> from both files and save as previousVersion.
• Ensure both files currently match. If they do not, resolve that mismatch before continuing.

2. Compute upstream diff and release context

• In reference/<sdk>/:
  • git fetch --tags
  • Build tags for previousVersion and newVersion.
  • For expo, tags use a v prefix (example: v0.1.3). Other SDKs use raw versions (example: 4.13.0).
  • Run:
    • git log --oneline <prevTag>..<newTag>
    • git diff --stat <prevTag>...<newTag>
    • git diff <prevTag>...<newTag> > /tmp/sdk.diff
• Extract the newVersion section from upstream CHANGELOG.md or release notes.
• Build a docs-update checklist from the raw diff and changelog before editing docs.

3. Apply doc updates

• Update docs under content/docs/<sdk>/... using the checklist.
• Follow authoring rules in content/README/AGENTS.md.
• Update <SdkLatestVersion ...> in both overview files to newVersion.
• Update content/docs/<sdk>/changelog.mdx additively:
  • Keep all existing historical entries.
  • Add the new upstream changelog entry in the correct place.
  • Do not replace the file with only the newest entry.
• Keep the checklist updated as each change is completed.

4. Verify

• Run bun run build:cf.
• Run bun test.
• Confirm git status only contains intended files.

5. Commit and PR

• Follow repository policy: request explicit user approval before commit, push, or PR creation.
• Commit message must be exactly: feat(<sdk>): update for <newVersion>.
• PR title must be exactly: feat(<sdk>): update for <newVersion>.
• PR body must include:
  • previousVersion -> newVersion
  • Upstream diff/tag links and changelog source
  • Checklist of doc updates performed
  • Follow-up tasks or known gaps

Common Gotchas and SDK-Specific Guidance

• General:
  • Forgetting to update both index.mdx and sdk-reference/index.mdx version markers.
  • Updating version markers only, while missing setup or guide content changes.
  • Replacing changelog history instead of appending the new entry.
• android:
  • Always verify and update dependency versions in content/docs/android/quickstart/install.mdx.
  • Ensure any changed Gradle/Kotlin setup snippets are reflected.
• ios:
  • Verify install/version snippets (SPM, CocoaPods, manual setup when present).
• flutter:
  • Verify pubspec.yaml dependency snippets and initialization examples.
• expo:
  • Use v-prefixed git tags when computing upstream diff.
  • Verify config plugin/setup docs when release notes mention setup changes.
• react-native:
  • Verify package install, autolinking, and platform setup sections for breaking changes.

Final Response Checklist

• Include upstream diff/tag references used for the update.
• Summarize doc changes by section/path.
• Call out remaining tasks, unknowns, or blockers.
• Confirm verification command results.