Skip to content

docs: consolidate on-device debugging chapters, add checkers & card game case studies#5220

Merged
shai-almog merged 2 commits into
masterfrom
docs-consolidate-ondevice-debugging-game-case-studies
Jun 11, 2026
Merged

docs: consolidate on-device debugging chapters, add checkers & card game case studies#5220
shai-almog merged 2 commits into
masterfrom
docs-consolidate-ondevice-debugging-game-case-studies

Conversation

@shai-almog

Copy link
Copy Markdown
Collaborator

Fixes #5215

On-device debugging consolidation (#5215)

The "On device debugging" section (21.3) in Advanced Topics/Under the Hood duplicated — in a very outdated form (Gradle 2.11 instructions, manual sources.zip merging) — what the dedicated On-Device Debugging chapters now cover. This PR consolidates it:

  • Advanced Topics: the section is now a short pointer to the two dedicated chapters; the obsolete walkthroughs and the orphaned gradle-settings.png are removed. The build-hint table links that pointed at non-existent #_ondevice_debugging_* anchors are fixed.
  • On-Device Debugging (iOS): new "Debugging the generated Xcode project natively" section — cn1:buildIosXcodeProject / cloud Include Source flag, the .xcworkspace guidance preserved from the old section, LLDB/Instruments, and how Java methods map to ParparVM-generated C symbols.
  • On-Device Debugging (Android): new "Debugging the generated Gradle project from Android Studio" section — cn1:buildAndroidGradleProject / cloud Include Source, modern Android Studio opens the generated project directly, plus an NDK/LLDB cross-reference. (The old userSources.jar advice was dropped; it no longer exists in the Maven build.)

Game Development chapter: checkers & card demos

CardGameSample and BoardGameSample were only name-dropped in bullets — no screenshots, no code. Added two case-study sections (placed as a bridge into "3D and perspective"):

  • Case study: the card game (flat 2D) — screenshot + discussion/code: sprite-per-card grid, the scale-through-zero flip with mid-flip image swap, polled tap hit-testing via GameInput, countdown-timer game-loop pattern.
  • Case study: faux-3D checkers (isometric projection) — screenshot + discussion/code: the 2:1 diamond projection and its inverse for tap-to-cell picking, (r+c) z-order depth, the shadow + raised-piece height illusion, and the rebuild-don't-mutate syncPieces() scene sync.

Both screenshots were captured from the simulator with the iPhoneX skin (matching the existing game-*.png style, 880px wide) and show genuine mid-game state — two matched pairs + one card mid-turn, and a checkers position after an exchange with a selected piece and highlighted destination.

Cross-reference cleanup

Validating the full-guide asciidoctor build surfaced four pre-existing unresolved cross-references, now fixed: missing [[working-with-codename-one-sources]] and [[TitleAndLabelImage]] anchors, and two <<binding-framework>> refs in io.asciidoc retargeted to the JSON/XML Object Mapping chapter.

The complete developer guide now builds with zero unresolved references.

🤖 Generated with Claude Code

Fixes #5215 by consolidating the stale "On device debugging" section
(21.3) in Advanced Topics into the dedicated per-platform chapters:

- Advanced Topics now points at the two dedicated chapters; the
  obsolete Gradle 2.11 / manual sources.zip walkthroughs are removed
  along with the orphaned gradle-settings.png.
- On-Device Debugging (iOS) gains "Debugging the generated Xcode
  project natively": cn1:buildIosXcodeProject / cloud Include Source,
  the .xcworkspace note, LLDB/Instruments and ParparVM C symbol names.
- On-Device Debugging (Android) gains "Debugging the generated Gradle
  project from Android Studio": cn1:buildAndroidGradleProject / cloud
  Include Source, plus an NDK/LLDB cross-reference.
- Fix the build-hint table links that pointed at non-existent
  #_ondevice_debugging_* anchors.

Also fills the two gaps in the Game Development chapter: dedicated
case-study sections with screenshots and code for CardGameSample
(sprite-per-card, scale-through-zero flip, polled tap hit-testing,
countdown timers) and BoardGameSample (isometric projection and
inverse picking, z-order depth, shadow + raised-piece height illusion,
rebuild-don't-mutate scene sync). Screenshots captured from the
simulator with the iPhoneX skin showing real mid-game state.

While validating the full-guide asciidoctor build, fixed the four
pre-existing unresolved cross-references (working-with-codename-one-
sources, TitleAndLabelImage, binding-framework x2); the guide now
builds with zero unresolved refs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Developer Guide build artifacts are available for download from this workflow run:

Developer Guide quality checks:

  • AsciiDoc linter: No issues found (report)
  • Vale: No alerts found (report)
  • Paragraph capitalization: No paragraph capitalization issues (report)
  • LanguageTool: No grammar matches (report)
  • Image references: No unused images detected (report)

@github-actions

Copy link
Copy Markdown
Contributor

Cloudflare Preview

Capitalize the case-study headings after the colon (and their xrefs),
spell out the four-by-four grid, avoid a paragraph-initial "But" and
drop an adverb flagged by Microsoft.Adverbs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@shai-almog shai-almog merged commit ab3ac6a into master Jun 11, 2026
10 of 12 checks passed
@shai-almog shai-almog deleted the docs-consolidate-ondevice-debugging-game-case-studies branch June 11, 2026 14:22
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.

Consolidate chapter 21.3 On Device Debugging to Chapter 35 On Device Debugging (Android)

1 participant