Skip to content

Sauce mobile beta/update restored sdk docs - #3694

Open
melekr wants to merge 11 commits into
mainfrom
sauce-mobile-beta/update_restored_SDK_docs
Open

melekr wants to merge 11 commits into
mainfrom
sauce-mobile-beta/update_restored_SDK_docs

Conversation

@melekr

@melekr melekr commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Restores the SDK documentation removed in #3362 and rewrites it for the Sauce Mobile Beta SDK, the beta-session SDK that runs beside Backtrace Error Reporting. The pages present the SDK as a new platform capability for customers who never used the TestFairy SDK.

  • Restore the SDK pages under docs/testfairy/sdk/ and add them to the sidebar as a Sauce Mobile Beta SDK category under App Distribution.
  • New page Using Sauce Mobile Beta with Backtrace: Backtrace owns crashes, init order per platform, shared sauce.* attributes to match a crash report with its session.
  • Install and usage for the current artifacts: iOS Swift package SauceMobileBeta 2.2.0-rc, Android com.saucelabs.mobilebeta:sauce-mobile-beta-android:2.2.0-rc, React Native @saucelabs/mobile-beta-react-native 3.0.0-rc.
  • New Migrating from the TestFairy SDK section: an overview plus step-by-step iOS, Android and React Native pages with a verification check per step. This is the only place the pages name the TestFairy SDK.
  • Beta label: a "Beta release" badge on the SDK pages and a beta note on the entry pages.
  • Removed: the legacy framework pages (Cordova, Flutter, Ionic, Unity, Xamarin, Titanium, NativeScript, Neptune, Lumberyard), the legacy crash handler page, and the dSYMs page (its content only applied to crashes captured by the TestFairy crash handler).
  • Bug Tracking keeps Jira Cloud only, rewritten from the V1.2 customer document (custom field mapping, dynamic placeholders, validation on save, attribute rules).
  • Exporting Ad Hoc IPA and Adding UDIDs moved to App Distribution, Installing Custom Enterprise Apps to Beta Testers.
  • Vale: heading exceptions for iOS, macOS, dSYM, npm, and front matter id values are no longer linted.

Preview: https://docs.dev.saucelabs.net/pr-preview/pr-3694/testfairy/sdk/adding-tf-sdk/

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

ref: BT-7792, BT-7861
ref: MAD-3366

thiagosaucelabs and others added 2 commits September 3, 2026 15:45
This reverts the removal of the TestFairy SDK documentation, restoring
docs/testfairy/sdk/, docs/testfairy/platforms/, using-testfairy/insights.md
and the SDK-related sections of the dashboard, builds, account settings,
GDPR, upload API and REST API pages.

Kept from main (not reverted):
- "Sauce Labs Mobile App Distribution" branding introduced by #3362
- Auto-Update removal (#3389) and the deleted auto-update.md page
- fastlane-plugin-saucelabs_appdist docs (#3414, #3434)
- Service accounts / API keys wording (#3360)
- Mobile App Storage distribution section (#3614)

Broken links reintroduced by the revert were repaired: dashboard.md and
gdpr.md had bare paths instead of markdown links, ms-app-center.md pointed
at the old TestFairy API name. `npm run build` passes with
onBrokenLinks/onBrokenAnchors/onBrokenMarkdownLinks set to throw.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- New page: Using Sauce Mobile Beta with Backtrace Error Reporting
- Sidebar: Sauce Mobile Beta SDK category (pages were unlisted since #3148)
- iOS/Android/React Native/Expo pages: crashless artifacts, versions, beginWithoutCrashHandler, migration from legacy TestFairy SDK 1.x
- Crash handler, options, production, attributes, identity, feedback pages aligned with the crashless SDK; feedback form customization added
- Rename "Sauce Labs Mobile App Distribution SDK" -> "Sauce Mobile Beta SDK" on SDK pages; legacy plugin pages unchanged
- Remove unreferenced stub using-app-dist.md
@melekr melekr self-assigned this Sep 28, 2026
@github-actions

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

melekr added 2 commits October 2, 2026 12:37
- Delete the Cordova, Flutter, Ionic, Lumberyard, NativeScript, Neptune, Titanium, Unity and Xamarin pages, the 11 images only they used, and their sidebar category.
- Remove the Cordova, NativeScript, Xamarin, Unity, Adobe Air and Titanium tabs from the SDK feature pages.
- List only Android, iOS and React Native (Expo with prebuild) on Supported Platforms and the SDK hub.
- Add a "Beta release" badge to the SDK pages, a beta note to the six entry pages, and a beta mention on the landing page.
- Map Locations: restore the missing "not" in the privacy sentence.
- iOS integration: remove the legacy CocoaPods video and align the GA wording with the beta note.
- Remote Logging: fill the empty Swift and React Native tabs.
- Hiding Data: rewrite the React Native example with useRef.
- Data Encryption: use the 256-bit AES key size throughout.
- Remove dead docs.testfairy.com links, fix bug-tracking titles and typos.
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

…capability and move everything about the TestFairy SDK into a dedicated migration guide.

- Reframe the SDK pages for readers who do not know the TestFairy SDK: no "formerly", "legacy" or replacement wording. Each page states the crash design once: the SDK installs no crash handler, Backtrace reports crashes.
- Add "Migrating from the TestFairy SDK": an overview plus step-by-step iOS, Android and React Native pages with a verification step per stage and troubleshooting. The SDK hub page carries the only pointer.
- Remove "Crash Handling (Legacy TestFairy SDK)" and the dSYMs page, whose content only applied to crashes captured by the TestFairy crash handler.
- Bug Tracking: keep Jira Cloud only, rewritten from the V1.2 customer document (custom field mapping, placeholders incl. session.publicUrl, validation on save, attribute rules). Remove the GitHub, Jira Server, Connect and Trello pages and 17 orphaned screenshots.
- Move Exporting Ad Hoc IPA and Adding UDIDs to App Distribution, and Installing Custom Enterprise Apps to Beta Testers.
- Corrections found in review: Backtrace Android addAttribute exists since 3.7.14, not 3.8.0; the Swift package product changed from TestFairy to SauceMobileBeta; the React Native package needs iOS 12.4 and API level 21 and bundles its own Maven repository.
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

@melekr
melekr marked this pull request as ready for review October 5, 2026 16:01
@melekr
melekr requested a review from a team as a code owner October 5, 2026 16:01
melekr added 2 commits October 6, 2026 13:30
Document the SDK side of the app update feature, which the backend controls per build but which apps can switch off, observe and replace.

- New page App Updates: how the prompt works, `disableAutoUpdate` for builds that must not update themselves, the session state callbacks, and `getDistributionStatus` for a custom update flow.
- Link the page from the SDK hub, Supported Platforms, the Android integration page, the React Native API notes and the production page, and merge the production page's two auto update guidelines into one.
@melekr
melekr requested a review from thiagosaucelabs October 6, 2026 17:50
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown

Deploy preview ready for 3694!
https://docs.dev.saucelabs.net/pr-preview/pr-3694

This branch has not been deployed

No deployments
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