docs: per-product LLM docs indexes for all products + global directory by raj-dubey1 · Pull Request #532 · cometchat/docs

raj-dubey1 · 2026-09-24T12:09:17Z

Extends the existing scoped LLM index convention to every remaining product, and adds a single global directory that links them all. Everything here is for AI agents / search, not the human sidebar.

Background

We already ship per-product llms-*.mdx scoped indexes for the 6 UI Kits and 5 Chat SDKs — unlisted (not in nav) but built, served as .md twins, and indexed for search + AI. The other products had none, and there was no central entry point. This PR fills the gaps.

What's new (all unlisted — for LLMs, not users)

9 new scoped indexes, generated from docs.json navigation, current version only, so links are real and never version-mixed:

Voice & Video Calling · AI Agents · AI Moderation · Notifications · Campaigns · Vue UI Kit v4 · Chat Widget · Chat REST & Management APIs · Chat Fundamentals & Extensions

1 global directory — llms-index.mdx, served at /docs/llms-index (deliberately a different name from llms.txt):

Links all 20 scoped indexes (11 existing + 9 new); points to the site-wide /llms.txt + /llms-full.txt.
Not in the sidebar — like the per-product indexes it's UNLISTED, NOT hidden: omitted from docs.json nav but built, served, and indexable for search + AI. This PR makes no docs.json change.

Quality (addressing review)

Current version only — Calls is v5-only (0 /calls/v4 links); Vue is v4-only (0 3.0/2.0 links).
Platform-qualified headings (e.g. ## JavaScript — Getting Started) so identical labels like Setup/Integration can't route an agent to the wrong platform.
No empty headings; duplicate labels disambiguated; capitalization fixed (JavaScript, HTML, WordPress, Next.js, iOS); plain & not &.
Dropped the single-link Insights index; the directory points straight at /insights.

Safety

Purely additive: new unlisted pages only, no nav/redirect/move/delete → no 404 or build risk.
Verified: docs.json valid & unchanged vs main; 869 links across all indexes + the directory, 0 broken.

The new indexes are generated (grouped links from nav, slug-derived labels), so they're more mechanical than the hand-curated UI Kit/SDK ones — accurate and complete, easy to enrich later.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E

…rectory Extends the existing scoped LLM index convention (UI Kits + Chat SDKs already shipped as unlisted llms-*.mdx) to every remaining product, and adds a global directory that links them all. New scoped indexes (generated from docs.json navigation so every link is a real, current page — 902 links, 0 broken): - Voice & Video Calling, AI Agents, AI Moderation, Notifications, Campaigns, Insights, Vue UI Kit, Chat Widget, Chat REST & Management APIs, Chat Fundamentals. New global directory: - llms-index.mdx (served at /docs/llms-index) — links all scoped indexes; distinct from Mintlify's auto site-wide /llms.txt and /llms-full.txt (which it points to). Added to the Developer Tools nav group so the set is discoverable. Per-product indexes stay unlisted (not hidden) per the existing convention: built, served as .md twins, and indexed for search + AI, but kept out of the human sidebar. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E

mintlify · 2026-09-24T12:09:20Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
cometchat	🟢 Ready	View Preview	Nov 12, 2026, 6:00 PM

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

@ketanyekale

…fied headings, cleaner labels Addresses @ketanyekale's review of the generated indexes: - Calls: no longer mixes v4/v5 — current version (v5) only, and headings are platform-qualified (e.g. "## JavaScript — Getting Started") so identical page labels like "Setup" can't route an agent to the wrong platform. (0 /calls/v4 links.) - Vue: v4 menu only — dropped v3/v2 pages and their garbled labels. (0 3.0/2.0 links.) - No empty headings (unnamed nav groups fall back to a real section name). - Duplicate labels within a section disambiguated (e.g. widget grouped by platform: ## HTML / ## WordPress …); capitalization fixed (JavaScript, HTML, WordPress, Next.js). - llms-index.mdx: plain & (not &); Insights points straight at /insights. - Removed insights/llms-insights.mdx (single link — not worth an index). Regenerated from docs.json navigation, current version only: 869 links, 0 broken. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E

…e human sidebar) Per request: the global directory is for agents/search, not users. Removed it from the docs.json Developer Tools nav (so it's not in the sidebar) and added the same 'unlisted, not hidden' note as the per-product indexes. It still builds, serves at /docs/llms-index, and stays indexable for search + AI. This PR now makes NO docs.json change — purely additive, unlisted pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E

… llms pages Removed the <Note> callout so the directory renders as a plain markdown links page like every per-product llms-* index (frontmatter + comment + headings + bullet links). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E

…k labels - Merge current main and regenerate the scoped indexes from docs.json navigation - "An AI Agents-scoped" (article picked from the scope name, fixed in the generator) - Framework labels: AG2, AG-UI, CrewAI, LangGraph (were Ag2, Ag UI, Crew AI, Langgraph) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NgVCxHs3h8m72GXvC8HaV1

raj-dubey1 · 2026-10-05T12:38:47Z

Refreshed on current main (a0c1d1f)

Merged current main (70 commits behind) with no conflicts, and regenerated every scoped index from docs.json navigation, current version only.
AI Agents coverage: every AI Agents page in the navigation is in the index, including the AG2 and AG-UI framework guides. My earlier "56 pages missing" note was wrong. Those files aren't in the navigation (the hidden ai-agents/apis/* pages, plus actions and tools), so they're left out on purpose.
Typo: now "An AI Agents-scoped…". The generator picks "A" or "An" from the scope name, so this stays fixed on regeneration.
Labels: AG2, AG-UI, CrewAI and LangGraph (were Ag2, Ag UI, Crew AI and Langgraph).
Page counts (unchanged):

Index Pages

AI Agents 135

Calls 165

Moderation 40

Notifications 81

Campaigns 61

Chat REST 252

Chat Fundamentals 47

Vue v4 43

Widget 13

Directory 23
Link check: 869 of 871 links resolve to existing pages. The two that don't are /llms.txt and /llms-full.txt, which Mintlify generates at build time. docs.json parses.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NgVCxHs3h8m72GXvC8HaV1

- notifications: the two Flutter push pages were merged on main into /notifications/flutter-push-notifications; link that one page. Add the Push getting-started page. - calls: add each platform's 'Migrating from Legacy Ringing' guide. - fundamentals: Network Allowlist. moderation: Engine Failures. - rest-api: the Chat APIs troubleshoot group's Error Guide and Properties and Constraints articles. - widget: Custom CSS and the v1 to v2 upgrade guide. Checked every index against main's docs.json navigation and redirects: 0 dead links and 0 current-version nav pages missing in each scope. The widget platform pages are in main's Widget Builder navigation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XbguTujAwRbSU5fkYZSyYq

jitvarpatil

Approving. The branch is level with main, every link resolves to a live page, and each index covers its product's current navigation.

Worth fixing in the generator, here or in a follow-up:

14 deprecated or legacy pages are listed without a label, though the description says current version only: fundamentals/llms-chat-fundamentals.mdx lines 47, 58, 59, 61, 63, 66, 67, 70 and 83 (their titles say Deprecated or Legacy), and rest-api/llms-chat-rest.mdx 57–60 (Restrict Features, replaced by RBAC) and 146–147 (deprecated conversation endpoints). Drop them or label them so agents don't pick them.
rest-api/llms-chat-rest.mdx:128 links /rest-api/messages/mark-message-as-interacted, which redirects to /rest-api/messages. The redirect is already on main.
Nav groups that share a name get merged under the first one. In rest-api/llms-chat-rest.mdx, the Management API error codes and properties pages sit under Chat's Troubleshoot (180–181), and the Data Import endpoints sit under Users, Groups and Messages (80, 101–102, 141), leaving Data Import with only its overview.

raj-dubey1 requested review from mathews-cometchat and siva-cometchat as code owners September 24, 2026 12:09

mintlify Bot deployed to staging September 24, 2026 12:13

View deployment

mintlify Bot deployed to staging September 25, 2026 07:52

View deployment

mintlify Bot deployed to staging September 25, 2026 07:56

View deployment

mintlify Bot deployed to staging September 25, 2026 08:00

View deployment

raj-dubey1 and others added 2 commits October 5, 2026 18:08

Merge remote-tracking branch 'origin/main' into docs/llms-scoped-indexes

1c5eada

mintlify Bot deployed to staging October 5, 2026 12:41

View deployment

raj-dubey1 and others added 2 commits November 12, 2026 23:26

Merge remote-tracking branch 'origin/main' into docs/llms-scoped-indexes

5e6c793

mintlify Bot deployed to staging November 12, 2026 18:00

View deployment

raj-dubey1 requested a review from ketanyekale November 12, 2026 18:02

ketanyekale approved these changes Nov 12, 2026

View reviewed changes

jitvarpatil approved these changes Nov 12, 2026

View reviewed changes

ketanyekale merged commit 73a1c75 into main Nov 13, 2026
5 checks passed

Navigation Menu

Repository navigation

docs: per-product LLM docs indexes for all products + global directory - #532

docs: per-product LLM docs indexes for all products + global directory#532
ketanyekale merged 8 commits into
mainfrom
docs/llms-scoped-indexes

raj-dubey1 commented Sep 24, 2026 •

edited

Loading

Uh oh!

mintlify Bot commented Sep 24, 2026 •

edited

Loading

Uh oh!

raj-dubey1 commented Oct 5, 2026

Uh oh!

jitvarpatil left a comment

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

raj-dubey1 commented Sep 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

What's new (all unlisted — for LLMs, not users)

Quality (addressing review)

Safety

Uh oh!

mintlify Bot commented Sep 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

raj-dubey1 commented Oct 5, 2026

Uh oh!

jitvarpatil left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

raj-dubey1 commented Sep 24, 2026 •

edited

Loading

mintlify Bot commented Sep 24, 2026 •

edited

Loading