Description
Document the :android module and its artifact (dev.appoutlet:some-android) across README, docs index, supported types, and a new dedicated Android section. The Android docs must be separate from core docs, following the same structure as docs/configuration/.
-
Scope and constraints
README.md — Add a paragraph under Installation documenting the two packages: dev.appoutlet:some (core, JVM) and dev.appoutlet:some-android (Android extension), with their respective Gradle snippets.docs/index.md — Mention both packages and what each is for, with a link to the new Android section.docs/getting-started.md — Add an Android installation subsection showing the some-android dependency.docs/supported-types.md — Add a table listing Android SDK types (Uri, Bundle, Pair, Rect, RectF, Point, PointF, Size, SizeF, UserHandle, android.graphics.Color) and Compose types (AnnotatedString, Color, SolidColor, Dp, Sp, Offset, Size, Rect, IntOffset, IntSize). Each group notes the artifact and that they auto-discover via ServiceLoader.docs/android/index.md — Create a new dedicated section (mirroring docs/configuration/index.md structure) covering:
- What some-android provides and why it is a separate artifact.
- Installation (
testImplementation("dev.appoutlet:some-android:{version}")).
- Supported Android SDK and Compose types (linked to supported-types.md for the full table).
- Available strategies:
UriStrategy (Random, Content, File, Url) and ColorStrategy (RandomArgb, RandomHsl, Palette) with code examples.
- Requirements (Android minSdk 21, Compose dependency).
- Follows existing docs conventions: Zensical frontmatter, tabs for Gradle/Maven, inline code examples.
- No code changes, documentation only.
-
References
Scope
In scope: README, docs/index.md, docs/getting-started.md, docs/supported-types.md, new docs/android/index.md.
Out of scope: implementation resolver changes, new strategies.
Acceptance criteria
Description
Document the
:androidmodule and its artifact (dev.appoutlet:some-android) across README, docs index, supported types, and a new dedicated Android section. The Android docs must be separate from core docs, following the same structure asdocs/configuration/.Scope and constraints
README.md— Add a paragraph under Installation documenting the two packages:dev.appoutlet:some(core, JVM) anddev.appoutlet:some-android(Android extension), with their respective Gradle snippets.docs/index.md— Mention both packages and what each is for, with a link to the new Android section.docs/getting-started.md— Add an Android installation subsection showing thesome-androiddependency.docs/supported-types.md— Add a table listing Android SDK types (Uri,Bundle,Pair,Rect,RectF,Point,PointF,Size,SizeF,UserHandle,android.graphics.Color) and Compose types (AnnotatedString,Color,SolidColor,Dp,Sp,Offset,Size,Rect,IntOffset,IntSize). Each group notes the artifact and that they auto-discover via ServiceLoader.docs/android/index.md— Create a new dedicated section (mirroringdocs/configuration/index.mdstructure) covering:testImplementation("dev.appoutlet:some-android:{version}")).UriStrategy(Random, Content, File, Url) andColorStrategy(RandomArgb, RandomHsl, Palette) with code examples.References
Scope
In scope: README, docs/index.md, docs/getting-started.md, docs/supported-types.md, new docs/android/index.md.
Out of scope: implementation resolver changes, new strategies.
Acceptance criteria
README.mddescribes bothsomeandsome-androidpackages with installation snippetsdocs/index.mdreferences both packages and links to the Android sectiondocs/getting-started.mdincludes Android installation instructionsdocs/supported-types.mdlists all Android SDK and Compose types with usage examplesdocs/android/index.mdexists with frontmatter, overview, installation, supported types, strategies, and examples