chore: getting started doc for iOS#1652
Merged
abdulraqeeb33 merged 2 commits intomainfrom Mar 10, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
One Line Summary
Add a Getting Started guide for running and testing the Red App (SwiftUI sample app).
Details
Motivation
New developers on the team had no concise onboarding document for building and running the iOS sample app locally. This PR adds a
GettingStarted.mdthat walks a Senior SWE through setup, running the app, and understanding every testable feature — reducing ramp-up time.Scope
GettingStarted.mdat the project root with prerequisites, three alternate ways to open the project in Xcode, App ID configuration, a full feature reference table, and common troubleshooting tips.docs/assets/red-app-screenshot.png— a screenshot of the Red App embedded in the guide for visual context.Testing
Unit testing
N/A — documentation-only change; no code modified.
Manual testing
Verified the markdown renders correctly on GitHub (headings, tables, image embed, code blocks) and confirmed all referenced file paths (
iOS_SDK/OneSignalSDK.xcworkspace,OneSignalSwiftUIExamplescheme,OneSignalService.swift) are accurate against the current repo structure.Affected code checklist
Checklist
Overview
Testing
Final pass
This change is