feat: implement Android reference generator + regenerate pages#1187
Merged
Conversation
Replace the no-op stub with a working Kotlin→MDX generator that parses the Seam Android SDK's public sources (KDoc) into the reference pages — the Android counterpart of ios-reference/generate.ts. The generator owns these pages and the SDK's public KDoc is the source of truth. - parse data classes, sealed hierarchies, enums, and the SeamSDK API class (companion methods, StateFlow properties, suspend/non-suspend methods) - nesting-aware, comment/string-aware Kotlin scanning so KDoc that embeds `/* */` and code examples parses correctly - render frontmatter + Overview + per-member sections (signatures, KDoc prose, @param/@return/@throws), and a CardGroup index; KDoc [Ref] links → inline code - parses sources directly (no Gradle/Dokka build): Dokka 1.9 has no clean structured output, and the public surface is small and well-KDoc'd Regenerates all 8 pages (these now match generator output, replacing the hand-authored seed). Output is bounded by KDoc fidelity — curated tables/prose aren't reproduced and stale KDoc examples are emitted verbatim (fix upstream). Validates: eslint, tsc, mintlify validate, and broken-links all pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
What
Replaces the no-op stub (#1186) with a working Kotlin→MDX generator for the Android SDK reference — the counterpart of
ios-reference/generate.ts. It parses the Seam Android SDK's public Kotlin sources (KDoc) and owns the reference pages, regenerating all 8 wholesale.Per the chosen model (iOS-style, generator owns the page), this regenerates the pages from KDoc — accepting that curated extras in the hand-authored versions (friendly provider-name tables, conceptual sections, bespoke examples) are not reproduced.
How it works
.ktfiles — no Gradle/Dokka build needed in CI. APAGESmanifest maps each public type → source file → slug.SeamSDKAPI class (companion methods, StateFlow properties, suspend/non-suspend methods)./* */and{ }/( )code examples parses correctly (this is what makescredentials/unlockand defaulted properties parse).## Overview+ per-member sections (signatures, KDoc prose,@param/@return/@throwstables) + a<CardGroup>index. KDoc[Ref]links → inline code.Validation
eslint,tsc,mintlify validate, andbroken-linksall pass. Sample output verified for the data class (SeamCredential), sealed hierarchies (SeamError), enum (UnlockProximity), and theSeamSDKAPI class.Known limitation (by design)
Output fidelity is bounded by the KDoc. Stale KDoc examples (e.g. the
unlockexample referencesSeamUnlockEvent.Connecting/SeamCredentialError.Invalid, which don't exist) are emitted verbatim — fix those upstream in the SDK's KDoc and the next sync corrects the docs.Companion: seamapi/phone (workflow switches to
--source+ enables the push trigger).🤖 Generated with Claude Code