From 9b3c325adec40d687a6cad980bccea242d9a68f8 Mon Sep 17 00:00:00 2001 From: Shagun Date: Mon, 17 Aug 2026 18:46:16 +0530 Subject: [PATCH] docs(ui-kit/angular): add scoped Angular v5 LLM docs index MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds ui-kit/angular/llms-angular-v5.mdx — a machine-readable, Angular-v5-scoped routing index of all 91 v5 pages as .md twins, for AI coding agents. Mirrors the shape of ui-kit/react/llms-react-v7.mdx (branch docs/react-v7-feature-guides). - Unlisted, NOT hidden: omitted from docs.json navigation so it never shows in the human sidebar, but still built, served as a .md twin, and indexed. Using `hidden: true` would auto-apply noindex and drop it from search + the global llms.txt, which defeats the purpose. docs.json is deliberately untouched. - Scoped to v5 only; the 2.0/, 3.0/ and v4/ trees are excluded so agents are never routed at dead API surfaces. - Angular-specific framing the React index has no equivalent for: kebab-case selectors, @Input() rather than props, content-projection/TemplateRef rather than render props, and env config in src/environments/environment.ts. Also fixes four content defects surfaced while building the index: - api-reference/formatter-config-service.mdx, api-reference/ rich-text-editor-service.mdx and guides/rich-text-formatting.mdx shipped with NO frontmatter at all despite being in docs.json navigation, so they rendered untitled. Adds title/description per house style (see api-reference/chat-state-service.mdx) and drops the two leading H1s that would now duplicate the frontmatter title. - overview.mdx "AI Integration Quick Reference" listed peer deps as @cometchat/chat-sdk-javascript + dompurify, missing @cometchat/cards-angular@^1.0.0 which @cometchat/chat-uikit-angular@5.1.0 added. Verified against the published package. NOT fixed here, needs an owner decision: the same accordion claims Angular "v18, v19, v20, v21, v22" but the published peer range at 5.1.0 is @angular/core ">=17.0.0 <22.0.0" — v22 is excluded (install hard-fails with ERESOLVE) and v17 is supported but undocumented. Either the docs or the peer range is wrong; that is a support-policy call, not a typo. Co-Authored-By: Claude Opus 5 --- .../formatter-config-service.mdx | 4 + .../rich-text-editor-service.mdx | 5 +- .../angular/guides/rich-text-formatting.mdx | 6 +- ui-kit/angular/llms-angular-v5.mdx | 156 ++++++++++++++++++ ui-kit/angular/overview.mdx | 2 +- 5 files changed, 170 insertions(+), 3 deletions(-) create mode 100644 ui-kit/angular/llms-angular-v5.mdx diff --git a/ui-kit/angular/api-reference/formatter-config-service.mdx b/ui-kit/angular/api-reference/formatter-config-service.mdx index a2cdc3eb6..9c09c96ab 100644 --- a/ui-kit/angular/api-reference/formatter-config-service.mdx +++ b/ui-kit/angular/api-reference/formatter-config-service.mdx @@ -1,3 +1,7 @@ +--- +title: "Formatter Config Service" +description: "Service Reference for the centralized text-formatter configuration service in CometChat Angular UIKit" +--- The `FormatterConfigService` is a centralized Angular service for managing default text formatters across the CometChat UIKit. It provides a single source of truth for formatter configuration, allowing you to set formatters once and have them automatically applied across all text-displaying components. diff --git a/ui-kit/angular/api-reference/rich-text-editor-service.mdx b/ui-kit/angular/api-reference/rich-text-editor-service.mdx index ebcb49dc5..70b488a6f 100644 --- a/ui-kit/angular/api-reference/rich-text-editor-service.mdx +++ b/ui-kit/angular/api-reference/rich-text-editor-service.mdx @@ -1,4 +1,7 @@ -# RichTextEditorService API Reference +--- +title: "Rich Text Editor Service" +description: "Service Reference for the native-API rich text editor service in CometChat Angular UIKit" +--- The `RichTextEditorService` is an Angular service that provides rich text editing capabilities using native browser APIs. It is a lightweight, custom implementation with no external dependencies. diff --git a/ui-kit/angular/guides/rich-text-formatting.mdx b/ui-kit/angular/guides/rich-text-formatting.mdx index b81bd7ebc..016a50e1d 100644 --- a/ui-kit/angular/guides/rich-text-formatting.mdx +++ b/ui-kit/angular/guides/rich-text-formatting.mdx @@ -1,4 +1,8 @@ -# Rich Text Formatting Guide +--- +title: "Rich Text Formatting" +sidebarTitle: "Rich Text Formatting" +description: "Apply rich text formatting — bold, italic, links and mentions — in the CometChat Angular UIKit." +--- This guide explains how to use rich text formatting in the CometChat Angular V5 UIKit, including text formatting, mentions, links, and more. diff --git a/ui-kit/angular/llms-angular-v5.mdx b/ui-kit/angular/llms-angular-v5.mdx new file mode 100644 index 000000000..4be4c090f --- /dev/null +++ b/ui-kit/angular/llms-angular-v5.mdx @@ -0,0 +1,156 @@ +--- +title: "Angular UI Kit v5 — LLM docs index" +description: "Machine-readable, Angular-v5-scoped index of every UI Kit page as a clean .md twin. Built for AI coding agents; kept out of the human sidebar." +--- + +{/* + SCOPED LLM INDEX for the Angular v5 UI Kit. + - UNLISTED, NOT hidden: intentionally omitted from docs.json navigation so it never shows in + the human sidebar — but it IS built, served as a clean .md twin, and INDEXED for search + + AI assistants (so AI tools, and the skills pack via its docs-map, can discover and read it). + - We deliberately do NOT use `hidden: true`/`noindex` here: in Mintlify `hidden` auto-applies + noindex, which would drop this page from search AND the auto global llms.txt / AI context. + We want it discoverable, so it stays indexable. + - Scope is v5 ONLY. The 2.0/, 3.0/ and v4/ trees are deliberately excluded — linking them + would route agents at dead API surfaces. +*/} + +# Angular UI Kit v5 — LLM docs index (Latest) + +> Stateful, drop-in Angular chat/calling UI. Package `@cometchat/chat-uikit-angular@5` + +> `@cometchat/chat-sdk-javascript@4` (peers also include `@cometchat/cards-angular@^1` and +> `dompurify@^3`). This page is an **Angular-v5-only** routing index for AI agents — a scoped +> alternative to the site-wide `/docs/llms.txt`. + +## How to use this index +Each link points to the docs page; **append `.md`** to its URL to fetch the clean Markdown twin +(verbatim code + an "AI Integration Quick Reference" block with input/output names, types, and +defaults). Pick the page for the intent, then read the API there. +- Convention: any docs page URL + `.md` → raw Markdown. +- Fallback: if a `.md` twin 404s, fetch the same URL **without** `.md` (HTML). Never read a + package `.d.ts` and never answer inputs/outputs from memory. +- Angular specifics: components are used as kebab-case selectors in templates + (``), configured via `@Input()`, and customized through + content-projection slots / `TemplateRef` — not React-style render props. + +## Hot path — usually no fetch needed +For a plain "add chat" the install, `init → login → render` ordering, standalone/NgModule imports, +and the core drop-in inputs are stable; a well-built agent skill bakes them. Fetch below only for +exhaustive inputs, long-tail components, theming tokens, or feature enablement. +- Setup: [Integration](/ui-kit/angular/integration) · [Quickstart](/ui-kit/angular/quickstart) +- Environment config lives in `src/environments/environment.ts` (not `.env`). +- Core drop-ins: [Conversations](/ui-kit/angular/components/cometchat-conversations) · [Message Header](/ui-kit/angular/components/cometchat-message-header) · [Message List](/ui-kit/angular/components/cometchat-message-list) · [Message Composer](/ui-kit/angular/components/cometchat-message-composer) + +## Getting started / integration +- [Angular UI Kit](/ui-kit/angular/overview) +- [Quickstart](/ui-kit/angular/quickstart) +- [Integration](/ui-kit/angular/integration) + +## Core & configuration +- [Core Features](/ui-kit/angular/core-features) +- [Methods](/ui-kit/angular/methods) +- [Events](/ui-kit/angular/events) +- [Sound Manager](/ui-kit/angular/sound-manager) +- [Extensions](/ui-kit/angular/extensions) +- [Campaigns](/ui-kit/angular/campaigns) +- [Accessibility](/ui-kit/angular/accessibility) +- [Troubleshooting](/ui-kit/angular/troubleshooting) +- [Services](/ui-kit/angular/api-reference/introduction) +- [Chat State Service](/ui-kit/angular/api-reference/chat-state-service) +- [CometChat Templates Service](/ui-kit/angular/api-reference/templates-service) +- [Formatter Config Service](/ui-kit/angular/api-reference/formatter-config-service) +- [Message Bubble Config Service](/ui-kit/angular/api-reference/message-bubble-config-service) +- [Rich Text Editor Service](/ui-kit/angular/api-reference/rich-text-editor-service) +- [Search Conversations Service](/ui-kit/angular/api-reference/search-conversations-service) +- [Search Messages Service](/ui-kit/angular/api-reference/search-messages-service) + +## Theming & customization +- [Theming](/ui-kit/angular/customization/theming) +- [Global Configuration](/ui-kit/angular/customization/global-config) +- [Localization](/ui-kit/angular/customization/localization) +- [Date & Time Formatting](/ui-kit/angular/customization/date-time-formatting) +- [Message Bubble Styling](/ui-kit/angular/message-bubble-styling) + +## Components — conversations & lists +- [Overview](/ui-kit/angular/components/components-overview) +- [Conversations](/ui-kit/angular/components/cometchat-conversations) +- [Conversation Item](/ui-kit/angular/components/cometchat-conversation-item) +- [Users](/ui-kit/angular/components/cometchat-users) +- [User Item](/ui-kit/angular/components/cometchat-user-item) +- [Groups](/ui-kit/angular/components/cometchat-groups) +- [Group Item](/ui-kit/angular/components/cometchat-group-item) +- [Group Members](/ui-kit/angular/components/cometchat-group-members) +- [Group Member Item](/ui-kit/angular/components/cometchat-group-member-item) + +## Components — messages +- [Message List](/ui-kit/angular/components/cometchat-message-list) +- [Message Composer](/ui-kit/angular/components/cometchat-message-composer) +- [Message Header](/ui-kit/angular/components/cometchat-message-header) +- [Message Information](/ui-kit/angular/components/cometchat-message-information) +- [Thread Header](/ui-kit/angular/components/cometchat-thread-header) +- [Reactions](/ui-kit/angular/components/cometchat-reactions) +- [Reaction Info](/ui-kit/angular/components/cometchat-reaction-info) +- [Reaction List](/ui-kit/angular/components/cometchat-reaction-list) +- [Stickers Keyboard](/ui-kit/angular/components/cometchat-stickers-keyboard) + +## Components — message bubbles +- [Action Bubble](/ui-kit/angular/components/cometchat-action-bubble) +- [Audio Bubble](/ui-kit/angular/components/cometchat-audio-bubble) +- [Call Bubble](/ui-kit/angular/components/cometchat-call-bubble) +- [Card Bubble](/ui-kit/angular/components/cometchat-card-bubble) +- [Collaborative Document Bubble](/ui-kit/angular/components/cometchat-collaborative-document-bubble) +- [Collaborative Whiteboard Bubble](/ui-kit/angular/components/cometchat-collaborative-whiteboard-bubble) +- [Delete Bubble](/ui-kit/angular/components/cometchat-delete-bubble) +- [File Bubble](/ui-kit/angular/components/cometchat-file-bubble) +- [Image Bubble](/ui-kit/angular/components/cometchat-image-bubble) +- [CometChatMarkdownRenderer](/ui-kit/angular/components/cometchat-markdown-renderer) +- [Message Bubble](/ui-kit/angular/components/cometchat-message-bubble) +- [Poll Bubble](/ui-kit/angular/components/cometchat-poll-bubble) +- [Sticker Bubble](/ui-kit/angular/components/cometchat-sticker-bubble) +- [Text Bubble](/ui-kit/angular/components/cometchat-text-bubble) +- [Video Bubble](/ui-kit/angular/components/cometchat-video-bubble) + +## Components — calling +- [Call Features](/ui-kit/angular/call-features) +- [Call Buttons](/ui-kit/angular/components/cometchat-call-buttons) +- [Call Logs](/ui-kit/angular/components/cometchat-call-logs) +- [Incoming Call](/ui-kit/angular/components/cometchat-incoming-call) +- [Outgoing Call](/ui-kit/angular/components/cometchat-outgoing-call) + +## Components — search, AI & notifications +- [AI Smart Chat Features](/ui-kit/angular/ai-features) +- [CometChatSearch](/ui-kit/angular/components/cometchat-search) +- [CometChatAIAssistantChat](/ui-kit/angular/components/cometchat-ai-assistant-chat) +- [Smart Replies](/ui-kit/angular/components/cometchat-smart-replies) +- [Conversation Starter](/ui-kit/angular/components/cometchat-conversation-starter) +- [Conversation Summary](/ui-kit/angular/components/cometchat-conversation-summary) +- [Notification Feed](/ui-kit/angular/components/notification-feed) + +## Task guides (recipes) +- [Block/Unblock Users](/ui-kit/angular/guides/block-unblock-user) +- [Call Log Details](/ui-kit/angular/guides/call-log-details) +- [Card Messages](/ui-kit/angular/guides/card-messages) +- [Custom Message Types](/ui-kit/angular/guides/custom-message-types) +- [Custom Text Formatter](/ui-kit/angular/guides/custom-text-formatter) +- [Group Chat](/ui-kit/angular/guides/group-chat) +- [Hashtag Formatter](/ui-kit/angular/guides/hashtag-formatter) +- [Mentions Formatter](/ui-kit/angular/guides/mentions-formatter) +- [Message Privately](/ui-kit/angular/guides/message-privately) +- [New Chat](/ui-kit/angular/guides/new-chat) +- [Rich Text Formatting](/ui-kit/angular/guides/rich-text-formatting) +- [Search Messages](/ui-kit/angular/guides/search-messages) +- [ShortCut Formatter](/ui-kit/angular/guides/shortcut-formatter) +- [State Management](/ui-kit/angular/guides/state-management) +- [RxJS Subscription Patterns](/ui-kit/angular/guides/subscription-patterns) +- [Threaded Messages](/ui-kit/angular/guides/threaded-messages) +- [URL Formatter](/ui-kit/angular/guides/url-formatter) + +## Framework recipes (full-page layouts) +- [Conversation List + Message View](/ui-kit/angular/angular-conversation) +- [One-to-One / Group Chat](/ui-kit/angular/angular-one-to-one-chat) +- [Tab-Based Chat](/ui-kit/angular/angular-tab-based-chat) + +## Migration & misc +- [Guides](/ui-kit/angular/guides/guides-overview) +- [Upgrading From V4](/ui-kit/angular/customization/migration-guide) + diff --git a/ui-kit/angular/overview.mdx b/ui-kit/angular/overview.mdx index a363c55c2..ee0f4ebb8 100644 --- a/ui-kit/angular/overview.mdx +++ b/ui-kit/angular/overview.mdx @@ -9,7 +9,7 @@ description: "Use CometChat Angular UI Kit to add standalone chat components, vo | Field | Value | | --- | --- | | Package | `@cometchat/chat-uikit-angular` v5.x | -| Peer deps | `@cometchat/chat-sdk-javascript`, `dompurify` | +| Peer deps | `@cometchat/chat-sdk-javascript`, `@cometchat/cards-angular`, `dompurify` | | Calling | Optional — `@cometchat/calls-sdk-javascript` | | Angular | v18, v19, v20, v21, v22 (v22 requires Node.js 24+) | | Localization | 19 languages built-in |