Skip to content

docs(ui-kit/angular): add scoped Angular v5 LLM docs index (ENG-38204) - #471

Open
shagundeogharkar wants to merge 1 commit into
mainfrom
docs/angular-v5-llms-index
Open

docs(ui-kit/angular): add scoped Angular v5 LLM docs index (ENG-38204)#471
shagundeogharkar wants to merge 1 commit into
mainfrom
docs/angular-v5-llms-index

Conversation

@shagundeogharkar

Copy link
Copy Markdown
Contributor

What & why

Part of ENG-38204 (Angular skills — UI Kit + SDK). That ticket's blocking prerequisite is a scoped llms.txt-style index for Angular, because the skills pack is docs-maximal: it builds features from the official task guides and compares its output against them. Without a scoped index there is no way for an agent to discover which guides exist, so it silently falls back to component-wiring and loses the guide-first completeness check.

Adds ui-kit/angular/llms-angular-v5.mdx — a machine-readable, Angular-v5-scoped routing index covering all 91 v5 pages as .md twins, in 13 sections. It mirrors the shape of ui-kit/react/llms-react-v7.mdx (currently on branch docs/react-v7-feature-guides, not yet on main).

No Angular SDK index is needed. The ticket asks for two indexes, but Angular consumes the same @cometchat/chat-sdk-javascript@4 as React, and the existing sdk/javascript/llms-javascript-v4.mdx is framework-agnostic — Angular inherits it unchanged.

Changes

New — ui-kit/angular/llms-angular-v5.mdx

  • Unlisted, NOT hidden. Deliberately omitted from docs.json navigation so it never appears in the human sidebar, but it still builds, serves its .md twin, and stays indexed. hidden: true was not used because Mintlify auto-applies noindex to hidden pages, which would drop this page from search and from the auto-generated global llms.txt — defeating the purpose. docs.json is untouched, so there are no navigation refs to break and no redirects required.
  • 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 that the React index has no equivalent for: kebab-case selectors in templates (<cometchat-conversations>), @Input() rather than props, content-projection / TemplateRef rather than render props, and environment config in src/environments/environment.ts rather than .env.
  • Section spine: getting started · core & configuration · theming & customization · five component groups · Task guides (recipes) (17 entries) · framework recipes · migration.

Fixes — four content defects surfaced while building the index

Three pages shipped with no frontmatter at all, despite being present in docs.json navigation, so they render untitled on the live site. Added title/description per house style (cf. api-reference/chat-state-service.mdx), and removed the two leading H1s that would now duplicate the frontmatter title:

File Was Now
api-reference/formatter-config-service.mdx no frontmatter title: "Formatter Config Service"
api-reference/rich-text-editor-service.mdx no frontmatter, leading # RichTextEditorService API Reference title: "Rich Text Editor Service"
guides/rich-text-formatting.mdx no frontmatter, leading # Rich Text Formatting Guide title: "Rich Text Formatting"

overview.mdx — "AI Integration Quick Reference" listed incomplete peer deps.

Value
Was @cometchat/chat-sdk-javascript, dompurify
Now @cometchat/chat-sdk-javascript, @cometchat/cards-angular, dompurify

Ground truth (verified against the shipped package)

The peer-dep fix was confirmed against the published package, not inferred:

$ npm view @cometchat/chat-uikit-angular@5.1.0 peerDependencies
{
  "dompurify": "^3.0.0",
  "@angular/core": ">=17.0.0 <22.0.0",
  "@angular/common": ">=17.0.0 <22.0.0",
  "@cometchat/cards-angular": "^1.0.0",     ← undocumented
  "@cometchat/chat-sdk-javascript": "^4.1.13",
  "@cometchat/calls-sdk-javascript": "^5.0.3"
}

@cometchat/cards-angular was added between 5.0.3 and 5.1.0 (latest is 5.1.0; there is no v6 line). Anyone following the docs today gets an incomplete install.

Not fixed here — needs an owner decision

The same overview.mdx accordion states:

| Angular | v18, v19, v20, v21, v22 (v22 requires Node.js 24+) |

But the published peer range at 5.1.0 is @angular/core ">=17.0.0 <22.0.0":

  • v22 is excludednpm install @cometchat/chat-uikit-angular@^5 on an Angular 22 project hard-fails with ERESOLVE. The docs currently advertise a version where install is impossible.
  • v17 is supported but undocumented.

So either the docs or the kit's peer range is wrong. That is a support-policy call for the UI Kit owners, not a typo, so this PR leaves the line untouched and flags it instead. It also blocks the Angular core skill, which has to state a supported range.

Checklist

  • Branch name follows the naming convention (docs/angular-v5-llms-index)
  • docs.json untouched — no nav refs changed, no redirects needed
  • All 91 links generated from the actual ui-kit/angular file tree, with page titles read from each file's frontmatter
  • Peer-dep change verified against the published npm package
  • npx mintlify dev not yet run — before merge, please confirm the page builds (a "not in navigation" warning is expected and intended) and that /ui-kit/angular/llms-angular-v5.md resolves as raw Markdown. The design depends on that twin being fetchable.

Follow-ups (not in this PR)

  • Quick Reference accordions on the 43 components/cometchat-*.mdx pages. The index tells agents each .md twin carries input/output names, types and defaults. That holds for guides/ and integration.mdx, but the component pages have no accordion yet, so the promise is currently partial. The React equivalent added these across 56 files in the same branch; for Angular it is deliberately split out as a separate, mechanical PR.
  • React's own indexes are still unmerged (docs/react-v7-feature-guides, docs/js-sdk-llms-index). Merging this one puts Angular's index in production while React's stays on a preview deploy — worth deciding whether those two should land as well, since the React skills pack currently documents .mintlify.site preview URLs as its docs base.

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 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 17, 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 17, 2026, 1:55 PM

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

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