Skip to content

chore: getting started doc for iOS#1652

Merged
abdulraqeeb33 merged 2 commits intomainfrom
getting_started
Mar 10, 2026
Merged

chore: getting started doc for iOS#1652
abdulraqeeb33 merged 2 commits intomainfrom
getting_started

Conversation

@abdulraqeeb33
Copy link
Contributor

@abdulraqeeb33 abdulraqeeb33 commented Mar 9, 2026

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.md that walks a Senior SWE through setup, running the app, and understanding every testable feature — reducing ramp-up time.

Scope

  • Added: GettingStarted.md at 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.
  • Added: docs/assets/red-app-screenshot.png — a screenshot of the Red App embedded in the guide for visual context.
  • No SDK source code, build configuration, or test changes.

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, OneSignalSwiftUIExample scheme, OneSignalService.swift) are accurate against the current repo structure.

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

None of the above apply — this is a documentation-only change.

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • Adds a single Getting Started guide and its supporting screenshot asset.
  • Any Public API changes are explained in the PR details and conform to existing APIs
    • N/A — no API changes.

Testing

  • I have included test coverage for these changes, or explained why they are not needed
    • Documentation-only; no testable code paths introduced.
  • All automated tests pass, or I explained why that is not possible
    • No tests affected.
  • I have personally tested this on my device, or explained why that is not possible
    • Verified markdown rendering and file-path accuracy; no runtime behavior to test on device.

Final pass

  • Code is as readable as possible.
    • Markdown is concise, uses tables for scanability, and provides three clearly labeled options for opening the project.
  • I have reviewed this PR myself, ensuring it meets each checklist item

This change is Reviewable

@abdulraqeeb33 abdulraqeeb33 changed the title getting started doc for iOS chore: getting started doc for iOS Mar 9, 2026
Copy link
Contributor

@nan-li nan-li left a comment

Choose a reason for hiding this comment

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

nice

@abdulraqeeb33 abdulraqeeb33 merged commit 10961f2 into main Mar 10, 2026
5 checks passed
@abdulraqeeb33 abdulraqeeb33 deleted the getting_started branch March 10, 2026 18:13
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.

2 participants