Uh oh!
There was an error while loading. Please reload this page.
Docs/android llms indexes - #481
Conversation
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…ompose and bump version numbers to 6.0.6
raj-dubey1
left a comment
There was a problem hiding this comment.
Docs review — Android LLM indexes (ENG-38205 / PR #175 companion)
Reviewed from the skills pack perspective: does this PR give the Android skills the docs surface they depend on?
✅ What's correct and solid
llms-android-v6.mdx — "unlisted not hidden" pattern correct (explicit rationale comment, no hidden: true, not in docs.json). Both cohorts covered prominently: "Two UI flavors of ONE kit: chatuikit-kotlin-android:6.+ (XML Views) and chatuikit-compose-android:6.+ (Jetpack Compose)". The hot-path section links both cohort entry points. The "How to use this index" section tells the agent to read the matching tab (Views vs Compose) on every component page. This is the right approach — keeping a single index that reflects the single-kit architecture.
Both-cohort cross-links complete: v6 UI Kit index → v5 SDK index, and v5 SDK index → v6 UI Kit index. getting-started-kotlin.mdx and getting-started-jetpack.mdx are both linked from the hot path.
Pending pages documented: The three features gated on feature/android-pin_save_thread (pinned-messages, saved-messages, guide-thread-subscription) are listed in a JSX comment block with the branch name and the instruction to uncomment when that branch merges. This matches the PENDING section in features.android-v6.json — the two files are in sync.
llms-android-v5.mdx (SDK) — present and cross-linked to the UI Kit index.
Docs corrections across 14+ pages: The ANDROID-DOCS-AUDIT.md methodology (mechanical diff of docs vs 6.0.5 source) produced 5 verified wrong method names in the live docs (A1–A5: setOnAcceptClick vs setOnAcceptClickListener, etc.). These align with the STOPGAP blocks in the skills pack core skill — once these corrections merge, those stopgaps can be removed.
⚠️ Items to address
1. PR description is very thin for the scope of changes
This PR touches 14+ existing docs pages, adds two index files, includes ANDROID-DOCS-AUDIT.md (documenting 5 wrong method names in production docs), and adds REPRO-enableCalling-launch-crash.md. The PR body is the default template with checkboxes but almost no description of what was corrected or why. For a PR this size, reviewers have no way to know which method names were fixed, which pages were corrected, or what the REPRO file documents.
Please add a PR body summary similar to PR #477's format — at minimum: a list of corrected pages, the method name corrections (equivalent to the A1–A5 list in ANDROID-DOCS-AUDIT.md), and a note about the enableCalling crash repro. This is a review-process issue, not a correctness issue, but it makes the PR significantly harder to review.
2. Confirm STOPGAP removal from skills pack after merge
The cometchat-android-v6-core/SKILL.md in PR #175 has two STOPGAP blocks that are explicitly tied to this PR merging. Merge order: PR #481 first → then remove the STOPGAP blocks from PR #175. If both merge simultaneously or in reverse order, the stopgap blocks will remain in the published skills indefinitely. Coordinate the merge order.
3. AUDIT-084 in the index
The index's hot-path section correctly points to getting-started-kotlin / getting-started-jetpack where AUDIT-084 wiring lives. Confirm both getting-started pages explicitly use CometChatUIKit.initFromSettings(this, callback) (not the classic UIKitSettingsBuilder + init()) — this is what the skills pack's contracts.android-v6.json verifies.
Summary
The two LLM indexes are well-structured, correctly unlisted, and cover both cohorts in the right way (single index, per-cohort tabs in linked pages). The docs corrections align with the oracle findings in the skills pack. Two procedural items before this lands cleanly: add a meaningful PR description, and coordinate merge order with PR #175 (docs first so the skill STOPGAP blocks can be removed).
APPROVE — with the PR description and merge-order notes above.
Uh oh!
There was an error while loading. Please reload this page.
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)