Skip to content

docs(react-native): scoped LLM indexes for UI Kit v5 + SDK v4 (ENG-38205) - #474

Closed
suraj-chauhan-cometchat wants to merge 2 commits into
mainfrom
docs/eng-38205-rn-llms-index
Closed

docs(react-native): scoped LLM indexes for UI Kit v5 + SDK v4 (ENG-38205)#474
suraj-chauhan-cometchat wants to merge 2 commits into
mainfrom
docs/eng-38205-rn-llms-index

Conversation

@suraj-chauhan-cometchat

Copy link
Copy Markdown
Contributor

Adds the two scoped LLM docs indexes for React Native — the stated prerequisite for ENG-38205.

  • ui-kit/react-native/llms-react-native-v5.mdx — UI Kit index, incl. Task guides (recipes)
  • sdk/react-native/llms-react-native-v4.mdx — SDK index

Follows the existing precedent exactly

Same shape as React (#446), JS SDK (#466) and Angular (#471): two separate files, unlisted in docs.json but indexed (deliberately not hidden: true, which auto-applies noindex and would drop them from search and the auto llms.txt), .md-twin fetch convention, hot-path section.

I checked those PRs before writing: none embeds an SDK section inside its UI-Kit index, so RN gets two files too. RN needs both because it has its own SDK (@cometchat/chat-sdk-react-native@4), unlike Angular which shares the JavaScript one.

Verified

  • 0 broken links across 110 targets
  • 100% page coverage — every page in ui-kit/react-native/ and sdk/react-native/ is linked, except redirect stubs and the self-link
  • versions confirmed from the docs themselves: UI Kit 5.4.0, SDK 4.0.28

One addition beyond the React template

A "Platform rules — React Native is not the web" section, because these are what an agent trained on the React kit gets wrong: no CSS/DOM, the real native peer-dep list, one screen per route, CLI vs Expo, and — on the SDK page — listener cleanup on unmount.

The peer list is taken from @cometchat/chat-uikit-react-native@5.4.0 + the integration pages, not inferred. It also carries the async-storage v3 Android local_repo Gradle requirement, which is a hard build failure if missed.

Not in this PR

15 docs gaps were found while building the skills (RN-G1RN-G15, all filed on ENG-38205) and none are fixed here — this PR is the prerequisite only. Two are worth pulling forward:

  • RN-G14pod install fails on every first bare-RN install without two modular_headers lines in the Podfile. Both official sample apps already carry them; react-native-cli-integration never mentions it.
  • RN-G9 — 7 pages import symbols the kit doesn't export, so those snippets don't compile.

🤖 Generated with Claude Code

ENG-38205 prerequisite. Two unlisted-but-indexed routing indexes for AI
coding agents, following the React v7 / Angular v5 / JS SDK v4 precedent:

- ui-kit/react-native/llms-react-native-v5.mdx (incl. Task guides (recipes))
- sdk/react-native/llms-react-native-v4.mdx

Both cover every page in their directory (redirect stubs excluded) and add
a "Platform rules" section for the React Native specifics an agent gets
wrong by default: no CSS/DOM, required native peer deps, one screen per
route, CLI vs Expo toolchains, and listener cleanup on the SDK side.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The first pass listed @gorhom/bottom-sheet + react-native-reanimated as
required peers. They are not. Replaced with the list verified against
@cometchat/chat-uikit-react-native@5.4.0 and the integration pages, and
added the async-storage v3 Android local_repo Gradle gotcha to both.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 19, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Aug 19, 2026, 12:02 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@suraj-chauhan-cometchat

Copy link
Copy Markdown
Contributor Author

Superseded by #476 — the two LLM index files are now cherry-picked onto docs/eng-38205-rn-gaps (b52e1ed2, 683476da), so the index and the pages it routes to ship as one reviewable change.

Splitting them was causing a concrete problem: reviewing this PR against the JS reference (#466) showed no Quick Reference changes, because they were all in #476. One PR removes that trap.

Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant