docs(ui-kit/angular): Angular v5 skills docs — LLM index + AI Integration Quick References (ENG-38204) - #475
Open
shagundeogharkar wants to merge 5 commits into
Open
docs(ui-kit/angular): Angular v5 skills docs — LLM index + AI Integration Quick References (ENG-38204)#475shagundeogharkar wants to merge 5 commits into
shagundeogharkar wants to merge 5 commits 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. |
5 tasks
…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.
…dex (#446 shape) Follows the shape landed for React in #446. The point is what it removes: no prop dump, so an agent can scan the accordion and only read on if what it needs is listed. Props/Events/Customization become anchors into the page's own sections — all 99 verified to resolve. Adds rows that are not derivable from type declarations and are where composition actually goes wrong: Primary output, Stitching, Automatic behaviour (what the kit already does, so it is not hand-rolled). Authored for the 12 mountable surfaces; bubbles get the short form since you never mount them. Mechanical rows (component, selector, CSS root class, imports) come from the kit's own declarations and its stylesheets — 71 of 81 selectors have a verifiable root class. notification-feed.mdx preserved: its hand-authored accordion is richer than anything generatable here.
…customization Closes the 13 v5 pages that had none. 78 of 92 now carry one; 126 in-page anchors verified to resolve. api-reference (8): services are method surfaces, so these use the SDK-shaped schema — Injection, Key methods, Reactive state (signals vs observables) — with methods and signals read from the kit's class declarations. Purpose is authored: one line stating what the service is for is what lets an agent skip a 2,400-word page it does not need. guides + customization (5): task pages, so the schema is what the page teaches, its key symbols, and the trap it exists to prevent — e.g. state-management warns against holding a local selected field alongside ChatStateService, which is why the list stops highlighting the open row.
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.
Umbrella branch for the Angular v5 docs work supporting ENG-38204 (the Angular skills pack). Kept as one PR so there is a single Mintlify preview covering every change while the work lands incrementally.
Supersedes #471, whose branch is merged in here.
Landed so far
ui-kit/angular/llms-angular-v5.mdx(new) — a machine-readable, Angular-v5-scoped routing index of all 91 v5 pages as.mdtwins, in 13 sections. Mirrorsui-kit/react/llms-react-v7.mdx.docs.jsonnavigation so it never appears in the human sidebar, but still built, served as a.mdtwin, and indexed.hidden: truewas rejected because Mintlify auto-appliesnoindex, which would drop it from search and the auto-generated globalllms.txt.docs.jsonis untouched — no nav refs changed, no redirects needed.2.0/,3.0/andv4/are excluded so agents are never routed at dead API surfaces.@Input()rather than props, content projection rather than render props, and config insrc/environments/environment.tsrather than.env.Four content fixes found while building the index:
api-reference/formatter-config-service.mdxapi-reference/rich-text-editor-service.mdxH1guides/rich-text-formatting.mdxoverview.mdx@cometchat/cards-angular, a required peer since kit 5.1.0All three untitled pages are present in
docs.jsonnavigation, so they were live and rendering without titles.Still to land on this branch
AI Integration Quick Reference accordions. #466 established a ten-field schema (
Package · Import · Key methods · Key classes · Primary output · Listeners registered · Prerequisites · Constraints · Related · Full reference) across 20 SDK pages. Angular's 43 component pages have none at all, andoverview.mdxcarries only a thin six-field version. Bringing them up to that standard is the main remaining work, and the reason this PR stays open rather than merging the index alone.Verified against the published package, not inferred
Not fixed here — needs an owner decision
overview.mdxstates Angularv18, v19, v20, v21, v22, but the published peer range is>=17.0.0 <22.0.0:npm installhard-fails withERESOLVE, so the docs advertise a version where install is impossible.Either the docs or the kit's peer range is wrong. That is a support-policy call for the UI Kit owners rather than a typo, so this PR flags it and leaves the line untouched.
Checklist
docs.jsonuntouched — no nav refs changed, no redirects neededui-kit/angularfile tree, titles read from each file's frontmatternpx mintlify devnot yet run — before merge, confirm the index page builds (a "not in navigation" warning is expected) and that/ui-kit/angular/llms-angular-v5.mdresolves as raw Markdown. The design depends on that twin being fetchable.Related
Several other Angular v5 docs branches are in flight (
docs/angular-v5-uikit,-version-update,-docs-update,-beta1). This branch touches onlyllms-angular-v5.mdxplus the four files above; worth a rebase check before merge if those land first.