docs(ui-kit/angular): add scoped Angular v5 LLM docs index (ENG-38204) - #471
Open
shagundeogharkar wants to merge 1 commit into
Open
docs(ui-kit/angular): add scoped Angular v5 LLM docs index (ENG-38204)#471shagundeogharkar wants to merge 1 commit into
shagundeogharkar wants to merge 1 commit into
Conversation
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>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdtwins, in 13 sections. It mirrors the shape ofui-kit/react/llms-react-v7.mdx(currently on branchdocs/react-v7-feature-guides, not yet onmain).No Angular SDK index is needed. The ticket asks for two indexes, but Angular consumes the same
@cometchat/chat-sdk-javascript@4as React, and the existingsdk/javascript/llms-javascript-v4.mdxis framework-agnostic — Angular inherits it unchanged.Changes
New —
ui-kit/angular/llms-angular-v5.mdxdocs.jsonnavigation so it never appears in the human sidebar, but it still builds, serves its.mdtwin, and stays indexed.hidden: truewas not used because Mintlify auto-appliesnoindexto hidden pages, which would drop this page from search and from the auto-generated globalllms.txt— defeating the purpose.docs.jsonis untouched, so there are no navigation refs to break and no redirects required.2.0/,3.0/andv4/trees are excluded so agents are never routed at dead API surfaces.<cometchat-conversations>),@Input()rather than props, content-projection /TemplateRefrather than render props, and environment config insrc/environments/environment.tsrather than.env.Fixes — four content defects surfaced while building the index
Three pages shipped with no frontmatter at all, despite being present in
docs.jsonnavigation, so they render untitled on the live site. Addedtitle/descriptionper house style (cf.api-reference/chat-state-service.mdx), and removed the two leadingH1s that would now duplicate the frontmatter title:api-reference/formatter-config-service.mdxtitle: "Formatter Config Service"api-reference/rich-text-editor-service.mdx# RichTextEditorService API Referencetitle: "Rich Text Editor Service"guides/rich-text-formatting.mdx# Rich Text Formatting Guidetitle: "Rich Text Formatting"overview.mdx— "AI Integration Quick Reference" listed incomplete peer deps.@cometchat/chat-sdk-javascript,dompurify@cometchat/chat-sdk-javascript,@cometchat/cards-angular,dompurifyGround truth (verified against the shipped package)
The peer-dep fix was confirmed against the published package, not inferred:
@cometchat/cards-angularwas added between5.0.3and5.1.0(latestis5.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.mdxaccordion states:But the published peer range at
5.1.0is@angular/core ">=17.0.0 <22.0.0":npm install @cometchat/chat-uikit-angular@^5on an Angular 22 project hard-fails withERESOLVE. The docs currently advertise a version where install is impossible.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
coreskill, which has to state a supported range.Checklist
docs/angular-v5-llms-index)docs.jsonuntouched — no nav refs changed, no redirects neededui-kit/angularfile tree, with page titles read from each file's frontmatternpx mintlify devnot 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.mdresolves as raw Markdown. The design depends on that twin being fetchable.Follow-ups (not in this PR)
components/cometchat-*.mdxpages. The index tells agents each.mdtwin carries input/output names, types and defaults. That holds forguides/andintegration.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.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.sitepreview URLs as its docs base.