8000 docs/18: options for an Android app outside this repository (proposed) by rleibman · Pull Request #163 · rleibman/thicket · GitHub
[go: up one dir, main page]

Skip to content

docs/18: options for an Android app outside this repository (proposed) - #163

Merged
rleibman merged 2 commits into
mainfrom
docs/android-getting-started
Nov 13, 2026
Merged

rleibman merged 2 commits into
mainfrom
docs/android-getting-started

Conversation

@rleibman
Copy link
Copy Markdown
Owner

Item 2 of the post-0.2.0 list: the design write-up, before anything is built.

docs/18-android-getting-started.md sets out the Android gap and three ways to close it, with questions for you in §18.6. GTK, macOS and the iOS simulator each have a template, an sbt-thicket plugin and a verify script that builds from Central alone. Android has none of the three.

The options

  • A (recommended): a ThicketAndroidPlugin in sbt-thicket and a hello-thicket-android template whose Gradle shell the app owns. One command, sbt thicketApk. This is the shape docs/07 §7.9 already planned.
  • B: Gradle only, with Scala compiled in a separate plain-JVM module. It's untested; S2 only showed that the Scala plugin can't go inside the Android module. It needs a spike first.
  • C: a template only, with no plugin.

Questions (§18.6)

  1. A, B or C?
  2. Debug or release build by default?
  3. APK only, or an AAB for the Play Store too?

The README's docs index also gains docs/17, which was missing.

🤖 Generated with Claude Code

…osed)

GTK, macOS and the iOS simulator have a template, an sbt-thicket plugin and a
verify script that builds from Central alone; Android has none. docs/18 lays out
what is fixed (Scala cannot compile inside the AGP module, measured in S2;
Gradle packages; Thicket jars from Central) and three shapes: A, an sbt plugin
plus an app-owned Gradle shell (recommended, docs/07 §7.9's plan); B, Gradle
only with a separate Scala JVM module (unmeasured, spike first); C, a template
only. Three questions for the owner in §18.6. Nothing is built.

README's docs index gains 17, which was missing, and 18.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…AB task

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note

Copilot was unable to complete this review at the selected tier due to model policy or plan restrictions.

🟢 Approval recommended

The change is limited to documentation additions and README index updates with no noted unresolved concerns in the provided review summary.

No open issues 🎉

What changed in this PR

Adds a proposed design write-up describing options to support building a Thicket-based Android app outside this repository (template and/or sbt/Gradle tooling), and updates the README docs index to include the new and previously-missing docs.

Changes:

  • Add docs/18-android-getting-started.md, outlining the Android “outside-repo” gap, three approaches (A/B/C), and open questions.
  • Update README.md documentation index to include docs/17 and docs/18 entries.
File Description
README.md Updates the documentation index to link to docs/17 and the new docs/18 document.
docs/​18-android-getting-started.md Introduces a proposed Android getting-started design doc covering external app template/tooling options and outstanding decisions.

Review effort: Balanced

@rleibman
rleibman merged commit eb5acfd into main Nov 13, 2026
1 of 2 checks passed
rleibman added a commit that referenced this pull request Nov 13, 2026
One conflict: docs/decisions.md, where both sides added a 2026-11-12 entry at
the top of the log. Both kept, the Android entry first.

Statements #162 brought in that this branch makes untrue, corrected in the same
merge: README's "no Android template or plugin yet" and docs/13's phase-5
"Still open: an Android template and plugin". docs/18's status (#163) goes from
"being built" to built.

Measured: sbt --error checkLinux on the merged tree, exit 0, 356 passed, 0 failed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
rleibman added a commit that referenced this pull request Nov 13, 2026
One conflict: docs/decisions.md, where main's two 2026-11-12 entries and this
branch's 2026-11-03 camera-preview entry were both added at the top. All kept,
newest first.

Brought in line with rules main gained since this branch:
- thicket-camera-preview-apple sets `description` (#157: every published module
  does; the POM's description is what Central's search shows).
- The Swift-carrying Apple modules are eight with this one, not seven:
  docs/14 §14.5 and bin/release.sh's header. docs/14's 2026-11-09 rehearsal
  record keeps "seven", which was true then.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in 9214 to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

0