Skip to content

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

Open
raj-dubey1 wants to merge 6 commits into
mainfrom
docs/llms-scoped-indexes
Open

raj-dubey1 wants to merge 6 commits into
mainfrom
docs/llms-scoped-indexes

Conversation

@raj-dubey1

@raj-dubey1 raj-dubey1 commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

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

mintlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
cometchat 🟢 Ready View Preview Oct 5, 2026, 12:41 PM

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

…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 &amp;); 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
raj-dubey1 and others added 2 commits October 5, 2026 18:08
…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

Copy link
Copy Markdown
Contributor Author

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

This branch was successfully deployed

1 active deployment
staging — a0c1d1f4 Deployed Oct 5, 2026 by mintlify[bot]
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