Skip to content

Added AI Integration references - #466

Open
raj-dubey1 wants to merge 2 commits into
mainfrom
docs/js-sdk-llms-index
Open

Added AI Integration references#466
raj-dubey1 wants to merge 2 commits into
mainfrom
docs/js-sdk-llms-index

Conversation

@raj-dubey1

Copy link
Copy Markdown
Contributor

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

@mintlify

mintlify Bot commented Aug 11, 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 11, 2026, 12:13 PM

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

shagundeogharkar added a commit that referenced this pull request Aug 20, 2026
…ent pages

Every value is read from the kit's own component declarations
(@cometchat/chat-uikit-angular 5.1.0), so the accordion cannot drift from the
shipped API — regenerate after a kit bump rather than hand-editing.

Schema follows #466 but adapted for a UI component: its SDK rows (Key methods,
Listeners registered) become Selector / Key inputs / Key outputs / View slots.
Import and Selector are separate rows because the exported class name and the
template selector differ, and confusing them is a known failure mode.

Bubbles get different Mounting/Prerequisites/Constraints rows: the message list
renders them when a matching message arrives, so telling an author to add one to
imports[] would be wrong guidance.

notification-feed.mdx is left untouched — its hand-authored accordion carries
per-input types, defaults and automaticBehaviors that cannot be generated from
type declarations, and a generated table would be a regression.
suraj-chauhan-cometchat added a commit that referenced this pull request Aug 20, 2026
…form

The AI Integration Quick Reference is a routing index: the agent scans it to
decide whether to open the page. 18 RN pages were carrying a shape that cannot
serve that job.

UI Kit (14) — replaced the JSON-blob accordion that docs#446 deleted from all
35 React component pages. Those blobs inlined the whole prop contract at 33-120
lines each, so there was nothing left to open the page for. Now a Field/Value
table: Component, Package, Import, Data props, Primary output, Other actions,
View slots, Styling, Prerequisites, Stitching -- names only, each linking into
the section that holds the detail.

SDK (4) — ai-agents, delivery-read-receipts, retrieve-group-members and
additional-message-filtering carried code dumps instead of the field table
their docs#466 twins use. Method and class names verified against the shipped
RN SDK, not copied from JS: createUploadFileRequest/uploadAttachments do not
exist in the RN SDK, so nothing from JS's upload-files table was reused.

Also fixes ccCallFailled -> ccCallFailed in call-buttons, incoming-call and
outgoing-call. All three shipped kits (5.3.0, 5.3.2, 5.3.4) emit ccCallFailed;
the misspelling would have sent the agent looking for an event that is never
fired. The v4 archive still carries it and was left alone.

Conceptual pages (overview, key-concepts, rate-limits, upgrading-from-v3,
message-structure-and-hierarchy, users-overview) were left untouched: docs#466
deliberately gives their JS twins no Quick Reference at all.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
suraj-chauhan-cometchat added a commit that referenced this pull request Aug 20, 2026
…References

docs#466 puts a consistent ~10-row field set on all 19 JS SDK method pages.
Ours had the right table form but a fraction of the rows: Package appeared on
1 page and Import on 0, against 19/19 in the reference PR. Import is the single
row an agent most needs to write working code, so its absence defeated the
routing index on every SDK page.

Adds the three mechanical rows -- Package, Import, Prerequisites -- which carry
the same value on every page and need no per-page judgement. Package and Import
lead the table, matching #466's row order.

setup-sdk and authentication-overview are skipped for Prerequisites: they are
themselves the pages the row links to, and must not cite themselves.

Still thinner than #466 and tracked separately: Primary output (4/38),
Related (5/38), Constraints (0/38) and Full reference (0/38) each need per-page
authoring rather than a mechanical fill.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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