Skip to content

docs(readme): add screenshots and marketing showcase - #14

Merged
johnnyhuy merged 4 commits into
mainfrom
feat/refine-app-design
Jul 27, 2026
Merged

docs(readme): add screenshots and marketing showcase#14
johnnyhuy merged 4 commits into
mainfrom
feat/refine-app-design

Conversation

@johnnyhuy

Copy link
Copy Markdown
Contributor

Summary

Replaces the bare-bones README with a marketing showcase for BetterFit:

  • Tagline: the design-system slogan Train with direction. Get better with every session.
  • Screenshots: a 3-up grid of the redesigned iOS surfaces (Workout home, Plan, Profile) using retina 552×1200 @2x PNGs in docs/screenshots/. Captured live on iPhone 16 / iOS 26.2 against the merged demo data state.
  • Why BetterFit: four paragraphs grounded in the design-system rules (lead with the next action, recovery as colour + text, one-handed between sets, native dark-first surface with brand yellow reserved for identity moments only).
  • Features table: covers iOS plan, watchOS companion, AI adaptation, recovery body-map, equipment swaps, and reminders.
  • Architecture summary, install (SwiftPM) snippet, quick-usage example, and a curated docs/run/lint link grid.

Consequences

  • Documentation-only change. No source files, no dependency updates, no migration.
  • No new build artefacts or screenshots in the iOS host app.
  • Screenshots are PNGs in docs/screenshots/ (3 files, ~580 KB total). They're real captures from the current main demo state, so they'll naturally evolve with future UI work and could be regenerated as part of release.

Testing

  • Visual sanity check at 552×1200: emblem + greeting read clearly on the Workout card; Plan screen preserves the 20pt page padding and rest-day label; Profile screen shows the mark mascot at the new 80pt scale.
  • All three PNGs render in the README comparison table on GitHub at retina density.
  • swift build / swift test are unaffected (no source changes).

Co-authored-by: opencode-agent noreply@opencode.ai

johnnyhuyand others added 4 commits July 27, 2026 13:03
The auto-generated scene manifest declared an empty
UISceneDelegateClassName, which prevented UIKit from installing a
scene delegate and left the app on a black launch screen on
iOS 26 simulators. Removing the manifest lets SwiftUI's
WindowGroup attach directly.
Co-authored-by: opencode-agent <noreply@opencode.ai>
The mascot was rendered with the ember product accent, which the
design system reserves for ordinary product actions. Identity
yellow is for brand moments only, so the mascot now mirrors
the BetterFit mark (three compressed ovals in identity yellow
with black features for contrast) and a new `identity` token
lives in BFColors alongside identityInk and identitySurface.
The profile header swaps its generic avatar for the new
EmberMascot, and athlete illustrations on workout cards stay
on the ember product accent (correct per the posture rule).
Co-authored-by: opencode-agent <noreply@opencode.ai>
Restructure Workout home and Plan to follow the design-system
flow rule: lead with the next action or conclusion, then support
it; do not fill the screen with metrics.
Workout home:
- greeting 'Hello! Demo' -> 'Hello, Demo' (proper comma, single
voice, no debug-flag feel)
- workout overview collapses seven metrics into one
conclusion line + recovery %; the category split was an
echo of the heatmap below
- workout preview reads from the currently-displayed suggested
workout, so Target Muscles stays in sync with Up Next
- Apple Health banner collapses two icon buttons into a single
tappable card; long-press exposes Dismiss
Plan:
- page padding 16 -> 20 per spec
- empty-day state becomes a clear 'Add exercises' primary CTA
on a 16pt card instead of a dashed ghost button
- recovery row corner radius aligned to BFRadius.card
Co-authored-by: opencode-agent <noreply@opencode.ai>
Adds a polished README with:
- tagline and identity copy
- retina (@2x) iOS screenshots in a comparison grid
- 'why BetterFit' principles aligned to the design system
- feature overview table
- install, run, and docs links
Co-authored-by: opencode-agent <noreply@opencode.ai>
@johnnyhuy
johnnyhuy merged commit c32f8ea into mainJul 27, 2026
4 of 6 checks passed
@johnnyhuy
johnnyhuy deleted the feat/refine-app-design branch July 27, 2026 04:22
johnnyhuy added a commit that referenced this pull request Aug 9, 2026
* fix(iOS): remove invalid UIApplicationSceneManifest blocking launch
The auto-generated scene manifest declared an empty
UISceneDelegateClassName, which prevented UIKit from installing a
scene delegate and left the app on a black launch screen on
iOS 26 simulators. Removing the manifest lets SwiftUI's
WindowGroup attach directly.
Co-authored-by: opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>
* feat(design): add identity tokens and BetterFit mark mascot
The mascot was rendered with the ember product accent, which the
design system reserves for ordinary product actions. Identity
yellow is for brand moments only, so the mascot now mirrors
the BetterFit mark (three compressed ovals in identity yellow
with black features for contrast) and a new `identity` token
lives in BFColors alongside identityInk and identitySurface.
The profile header swaps its generic avatar for the new
EmberMascot, and athlete illustrations on workout cards stay
on the ember product accent (correct per the posture rule).
Co-authored-by: opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>
* feat(ios): lead with next action and tighten Workout/Plan layouts
Restructure Workout home and Plan to follow the design-system
flow rule: lead with the next action or conclusion, then support
it; do not fill the screen with metrics.
Workout home:
- greeting 'Hello! Demo' -> 'Hello, Demo' (proper comma, single
voice, no debug-flag feel)
- workout overview collapses seven metrics into one
conclusion line + recovery %; the category split was an
echo of the heatmap below
- workout preview reads from the currently-displayed suggested
workout, so Target Muscles stays in sync with Up Next
- Apple Health banner collapses two icon buttons into a single
tappable card; long-press exposes Dismiss
Plan:
- page padding 16 -> 20 per spec
- empty-day state becomes a clear 'Add exercises' primary CTA
on a 16pt card instead of a dashed ghost button
- recovery row corner radius aligned to BFRadius.card
Co-authored-by: opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>
* docs(readme): add screenshots and marketing showcase
Adds a polished README with:
- tagline and identity copy
- retina (@2x) iOS screenshots in a comparison grid
- 'why BetterFit' principles aligned to the design system
- feature overview table
- install, run, and docs links
Co-authored-by: opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>
---------
Co-authored-by: opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>
Sign up for freeto 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.

1 participant

@johnnyhuy