Merged
Conversation
added 2 commits
March 9, 2026 17:23
Contributor
📊 Diff Coverage Report✓ Coverage check passed (no source files changed) |
fadi-george
approved these changes
Mar 9, 2026
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
2 participants
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 the Red App (sample/demo app) with a screenshot.
Details
Motivation
There was no developer-facing documentation for building, running, and navigating the Red App. A new team member or senior engineer picking up the repo had to reverse-engineer the project structure, build variants, and feature set on their own. This PR adds a concise
GettingStarted.mdto close that gap.Scope
examples/demo/GettingStarted.md— covers prerequisites, two ways to open the project in Android Studio (standalone vs local SDK source), build variant selection, build & run steps, a full feature overview of every section in the app, SDK version override instructions, and a troubleshooting table.examples/demo/assets/red-app-screenshot.png— screenshot of the app after a successful launch, embedded in the doc.Testing
Unit testing
N/A — documentation-only change, no code modified.
Manual testing
Verified the markdown renders correctly with the embedded screenshot. Confirmed all referenced paths, build commands, and Gradle properties are accurate against the current project configuration.
Affected code checklist
None of the above are affected — this is a docs-only change.
Checklist
Overview
Testing
Final pass
This change is