feat: scaffold Android reference doc generator (no-op stub)#1186
Merged
Conversation
The Android counterpart of mintlify-codegen/ios-reference/. Adds a no-op generate.ts + README so the seamapi/phone Android docs-sync workflow can run end-to-end safely while the real Dokka→MDX generator is built. The stub accepts --archive and exits 0 without writing any files, so the sync workflow is a safe no-op — the hand-authored Android reference pages (DOC-231) are never overwritten. README documents the intended pipeline and the key design decision (which Dokka output to parse). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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
Adds
mintlify-codegen/android-reference/— the Android counterpart ofios-reference/:generate.ts— a no-op stub mirroring the iOS generator's CLI (--archiveflag +DOKKA_ARCHIVEenv). It writes nothing and exits 0.README.md— the intended Dokka → MDX pipeline and the key design decision before implementing.Why a stub
It lets the phone-side Android sync workflow run end-to-end safely: the stub produces no diff → no PR is opened → the carefully hand-authored Android reference pages (DOC-231) are never overwritten. The real generator lands next.
The real work (next)
Unlike Swift-DocC, Dokka 1.9 has no clean per-symbol JSON, so the open decision is which Dokka output to parse (
dokkaHtmlMultiModuleHTML,dokkaGfmMultiModuleMarkdown, or the Kotlin sources directly) — best decided against a real Dokka build's output. Details in the README.Companion: seamapi/phone#1201.
🤖 Generated with Claude Code