#!/usr/bin/env node /** * Generate llms.txt artifacts for the Telnyx developer docs. * * Usage: node scripts/generate-llms-txt.js * * Reads docs.json from the repo root, walks the navigation tree, * and produces: * * Committed to the repo (served by Mintlify, which only serves these * exact filenames — any other root/public .txt 404s): * llms.txt – root index (<50K) linking every per-section and * per-subsection file; overrides Mintlify's auto * llms.txt * llms-full.txt – <200K map: auth + quickstarts + links to the * per-area full-content files (overrides auto version) * public/llms.txt – copy of llms.txt * public/llms-full.txt – copy of llms-full.txt * * Also committed — regenerated on every run and served as native Mintlify * Markdown routes: * development/llms/-llms-txt/index.mdx * development/llms/-llms-full-txt/index.mdx * development/llms/-_{-llms-txt/index.mdx
* development/llms/-_{-llms-full-txt/index.mdx
* docs.json – a "For AI Agents" group inside every subsection
* pointing at the two landing pages (idempotent)
*
* Temporary build artifacts are written to llms-out/ and embedded into the
* generated Mintlify pages above. llms-out/ itself remains gitignored:
* llms-out/.txt – per-section index (pages + endpoints)
* llms-out/-full.txt – per-section full page content
* llms-out//_{.txt – per-subsection index
* llms-out//_{-full.txt – per-subsection full page content
* llms-out/api-reference-N.txt – per-operation endpoint index shards
*
* All links inside llms-out/ files are absolute so copied static assets do
* not depend on their eventual directory depth.
*
* Follows the llms.txt convention: https://llmstxt.org/
*/

const fs = require("fs");
const path = require("path");
const yaml = require("js-yaml");

const REPO_ROOT = path.resolve(__dirname, "..");
const DOCS_JSON_PATH = path.join(REPO_ROOT, "docs.json");
const PUBLIC_DIR = path.join(REPO_ROOT, "public");
const LLMS_OUT_DIR = path.join(REPO_ROOT, "llms-out");
// Generated sidebar landing pages live here (wiped + rewritten every run).
const LANDING_DIR = path.join(REPO_ROOT, "development", "llms");
const BASE_URL = "https://developers.telnyx.com";
const CONSOLIDATED_OPENAPI_SPEC_URL =
"https://raw.githubusercontent.com/team-telnyx/openapi/master/openapi/spec3.json";

// Hard ceiling for the root index — several agent tools truncate or reject
// llms.txt files around 50K characters.
const ROOT_INDEX_MAX_CHARS = 50000;

// Slugify a title/tag the same way Mintlify renders OpenAPI operation routes:
// apostrophes, slashes, and parentheses are stripped (not hyphenated);
// underscores are preserved as-is; everything else collapses to single hyphens.
function slugifyOpenApi(s) {
return (s || "")
.toLowerCase()
.replace(/['/()]/g, "")
.replace(/[^a-z0-9_]+/g, "-")
.replace(/^-|-$/g, "");
}

// ---------------------------------------------------------------------------
// Tabs: order, slugs, and descriptions for the per-section files
// ---------------------------------------------------------------------------

const TAB_ORDER = [
"Development", "AI", "Compute", "Storage", "Calling", "Voice", "Messaging",
"Numbers", "Wireless", "Other APIs"
];

const TAB_SLUGS = {
"Development": "development",
"AI": "ai",
"Compute": "compute",
"Storage": "storage",
"Calling": "calling",
"Voice": "voice",
"Messaging": "messaging",
"Numbers": "numbers",
"Wireless": "wireless",
"Other APIs": "other-apis",
};

const TAB_DESCRIPTIONS = {
"Development":
"Account setup, authentication, API fundamentals, SDKs, CLI, MCP servers, and integration guides",
"AI": "Inference, AI assistants, missions, and LiveKit integrations",
"Calling":
"TeXML, SIP trunking, UAC connections, WebRTC, and trusted calling",
"Voice": "Voice API, speech-to-text, text-to-speech, and voice design",
"Messaging":
"SMS, MMS, RCS, WhatsApp, short codes, 10DLC compliance, and messaging profiles",
"Numbers":
"Phone number search and ordering, porting, regulatory requirements, and identity",
"Compute": "Edge compute functions, runtime bindings, stateful actors, and private networking",
"Storage": "S3-compatible cloud storage with buckets, SDKs, and migration from AWS",
"Wireless": "SIMs, eSIMs, IoT data plans, VoLTE, and wireless messaging",
"Other APIs": "Account and billing, video, fax, SETI, OAuth, and platform APIs",
};

// ---------------------------------------------------------------------------
// Agent-facing sections shared by the root llms.txt and llms-full.txt
// ---------------------------------------------------------------------------

const USE_CASES_MD = `## Use cases

- Voice AI agents and IVR: real-time voice assistants combining carrier-grade calling with STT, TTS, and LLM inference on one platform
- Programmatic messaging: SMS, MMS, RCS, and WhatsApp for OTP, alerts, and campaigns
- Phone numbers: search, order, port, and configure numbers programmatically across global markets
- IoT connectivity: SIMs and eSIMs with per-MB data and private wireless
- AI inference: OpenAI-compatible chat completions and embeddings hosted on Telnyx GPUs
- Networking and storage: private IP networking and S3-compatible cloud storage

`;

const CONSTRAINTS_MD = `## Constraints

- Authentication: Bearer API key on every request (create one at https://portal.telnyx.com, or programmatically via https://telnyx.com/agent-signup.md)
- Base URL: https://api.telnyx.com/v2 (REST, JSON request/response)
- Rate limits are enforced per endpoint — see APIs fundamentals under the Development section
- US A2P messaging requires 10DLC registration; some number purchases require country-specific regulatory documents
- Webhooks are Ed25519-signed — verify signatures before trusting payloads

`;

const FOR_AGENTS_MD = `## For AI agents

- When to use Telnyx: tasks requiring programmable voice or calls, messaging, phone numbers, wireless connectivity, AI inference, or low-latency media
- REST: use the consolidated OpenAPI spec linked below with header \`Authorization: Bearer \`
- MCP (API actions): connect to https://api.telnyx.com/v2/mcp (streamable-http, same Bearer auth); discover tools with list_api_endpoints, inspect with get_api_endpoint_schema, then invoke_api_endpoint
- MCP (docs search): https://developers.telnyx.com/mcp (no auth)
- Credential walkthrough (auth.md convention): https://developers.telnyx.com/auth.md
- Authentication, step by step: (1) register at https://telnyx.com/sign-up — or programmatically via https://telnyx.com/agent-signup.md; (2) create a V2 API key at https://portal.telnyx.com/#/app/api-keys; (3) send it on every request as \`Authorization: Bearer \` against https://api.telnyx.com/v2; (4) rotate or revoke keys any time on the same portal page
- Agent platform configs (AGENTS.md, .cursorrules, .claude/, .windsurf/): https://github.com/team-telnyx/ai
- Machine-readable capabilities: https://telnyx.com/ai/capabilities.json · Pricing: https://telnyx.com/pricing.md · Agent fast path: https://telnyx.com/agents/start
- Differentiation vs alternatives: https://developers.telnyx.com/compare

`;

const WHY_TELNYX_MD = `## Why Telnyx (vs alternatives)

Unlike reseller CPaaS platforms (e.g. Twilio or Vonage), Telnyx owns and operates its global carrier network and runs AI inference on its own GPU infrastructure — one platform and one bill for voice, messaging, numbers, wireless, and AI, with usage-based rates published openly at https://telnyx.com/pricing.md. See https://telnyx.com/why-telnyx, the comparison page at https://developers.telnyx.com/compare.md, and the Twilio migration guide in the Development section.

`;

const AUTH_QUICKSTART_MD = `## Authentication

Every API request authenticates with a Bearer API key:

\`\`\`bash
curl https://api.telnyx.com/v2/available_phone_numbers \\
-H "Authorization: Bearer $TELNYX_API_KEY"
\`\`\`

Create a key in the Mission Control Portal (https://portal.telnyx.com) or programmatically via the agent signup flow (https://telnyx.com/agent-signup.md).

## Quickstart examples

Send an SMS:

\`\`\`bash
curl -X POST https://api.telnyx.com/v2/messages \\
-H "Authorization: Bearer $TELNYX_API_KEY" \\
-H "Content-Type: application/json" \\
-d '{"from": "+13125550100", "to": "+13125550101", "text": "Hello from Telnyx"}'
\`\`\`

Chat completion (OpenAI-compatible):

\`\`\`bash
curl -X POST https://api.telnyx.com/v2/ai/chat/completions \\
-H "Authorization: Bearer $TELNYX_API_KEY" \\
-H "Content-Type: application/json" \\
-d '{"model": "meta-llama/Llama-3.3-70B-Instruct", "messages": [{"role": "user", "content": "Hello"}]}'
\`\`\`

`;

function tabIndexUrl(tabName) {
if (tabName === "Development") return `${BASE_URL}/development/llms-txt.md`;
return `${BASE_URL}/development/llms/${TAB_SLUGS[tabName]}-llms-txt.md`;
}

function tabFullUrl(tabName) {
if (tabName === "Development") return `${BASE_URL}/development/llms-txt-full.md`;
return `${BASE_URL}/development/llms/${TAB_SLUGS[tabName]}-llms-full-txt.md`;
}

// Groups to skip (not real content groups)
const SKIP_GROUPS = new Set([
"🤖 For AI Agents",
"For AI Agents",
"Migration Guides",
"Glossary",
]);

// Keep docs-only MCP Apps pages out of developer-docs llms indexes so
// scanners don't treat the docs MCP surface as promising app UI resources.
// Product MCP Apps remain discoverable from the product MCP server itself.
const LLMS_INDEX_SKIP_REFS = new Set(["development/mcp/mcp-apps/index"]);

// ---------------------------------------------------------------------------
// Subsections (the menu items / top-level groups inside each tab)
// ---------------------------------------------------------------------------

// Keep generated URLs short where a literal slugification would be unwieldy.
const SUBSECTION_SLUG_OVERRIDES = {
"LiveKit on Telnyx (Beta)": "livekit",
};

function subsectionSlug(subName) {
return SUBSECTION_SLUG_OVERRIDES[subName] || slugifyOpenApi(subName);
}

function subIndexUrl(tabName, subName) {
return `${BASE_URL}/development/llms/${landingBase(tabName, subName)}-llms-txt.md`;
}

function subFullUrl(tabName, subName) {
return `${BASE_URL}/development/llms/${landingBase(tabName, subName)}-llms-full-txt.md`;
}

// Composite key for per-subsection maps.
function subKey(tabName, subName) {
return `${tabName} ${subName}`;
}

// Tab → ordered list of subsection names, straight from docs.json.
// Derived dynamically so new menu items / groups are picked up with no
// code change (a hardcoded map here went stale within weeks in May).
function deriveSubsections(docsJson) {
const map = new Map();
for (const tab of docsJson.navigation?.tabs || []) {
const subs = [];
if (tab.menu) {
for (const m of tab.menu) {
const n = m.item;
if (!n || !n.trim() || SKIP_GROUPS.has(n)) continue;
subs.push(n);
}
} else if (tab.groups) {
for (const g of tab.groups) {
const n = g.group;
if (!n || !n.trim() || SKIP_GROUPS.has(n)) continue;
subs.push(n);
}
}
map.set(tab.tab, subs);
}
return map;
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

function readDocsJson() {
const raw = fs.readFileSync(DOCS_JSON_PATH, "utf8");
return JSON.parse(raw);
}

function parseFrontmatter(content) {
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
if (!match) return null;
const fm = {};
const lines = match[1].split(/\r?\n/);
for (const line of lines) {
const m = line.match(/^(\w[\w-]*):\s*(.*)$/);
if (m) {
let val = m[2].trim();
if (
(val.startsWith('"') && val.endsWith('"')) ||
(val.startsWith("'") && val.endsWith("'"))
) {
val = val.slice(1, -1);
}
fm[m[1]] = val;
}
}
return fm;
}

function stripFrontmatter(content) {
return content.replace(/^---\r?\n[\s\S]*?\r?\n---\r?\n?/, "");
}

function stripMdxComponents(content) {
const lines = content.split("\n");
const result = [];
let inCodeBlock = false;

for (const line of lines) {
if (line.trimStart().startsWith("```")) {
inCodeBlock = !inCodeBlock;
result.push(line);
continue;
}
if (inCodeBlock) {
result.push(line);
continue;
}

// Skip self-closing JSX tags
if (/^<\w+[^>]*\/>\s*$/.test(line.trim())) {
continue;
}

// Skip opening JSX tags on their own line
if (/^<\w+[^>]*>\s*$/.test(line.trim())) {
continue;
}

// Skip closing JSX tags
if (/^<\/\w+[^>]*>\s*$/.test(line.trim())) {
continue;
}

// Skip import statements
if (/^import\s/.test(line.trim())) {
continue;
}

// Skip export statements
if (/^export\s/.test(line.trim())) {
continue;
}

result.push(line);
}

let output = result.join("\n");

// Remove self-closing JSX tags inline
output = output.replace(/<\w+[^>]*\/>/g, "");

// Remove opening/closing tags but keep content between them
output = output.replace(/<\/?\w+[^>]*>/g, "");

// Collapse multiple blank lines to at most two
output = output.replace(/\n{3,}/g, "\n\n");

return output.trim();
}

function pageRefToUrl(ref) {
let slug = ref;
if (slug.endsWith("/index")) {
slug = slug.slice(0, -6);
}
return `${BASE_URL}/${slug}`;
}

/**
* Append .md to same-origin URLs so agents get markdown instead of HTML.
*/
function toMdUrl(url) {
if (url && url.startsWith(BASE_URL)) {
return url + ".md";
}
return url;
}

function shouldSkip(ref) {
if (typeof ref !== "string") return false;
if (ref.startsWith("https://")) return true;
if (/^(GET|POST|PUT|PATCH|DELETE|OPTIONS|HEAD)\s\//.test(ref)) return true;
return false;
}

function resolveMdxPath(ref) {
const p = path.join(REPO_ROOT, `${ref}.mdx`);
if (fs.existsSync(p)) return p;
return null;
}

// Truncate a frontmatter description for index bullets.
function shortDescription(s, max = 200) {
if (!s) return "";
const oneLine = s.split("\n")[0].trim();
if (oneLine.length <= max) return oneLine;
return oneLine.slice(0, max - 1).trimEnd() + "…";
}

// ---------------------------------------------------------------------------
// Navigation tree walker
// ---------------------------------------------------------------------------

function walkNavigation(docsJson) {
const tabs = docsJson.navigation?.tabs || [];
const allPages = [];

for (const tab of tabs) {
const tabName = tab.tab;

if (tab.menu) {
for (const menuItem of tab.menu) {
const itemName = menuItem.item;
if (SKIP_GROUPS.has(itemName)) continue;

for (const group of menuItem.groups || []) {
walkPages(group.pages || [], tabName, [itemName, group.group], allPages);
}
if (menuItem.pages) {
walkPages(menuItem.pages, tabName, [itemName], allPages);
}
}
} else if (tab.groups) {
for (const group of tab.groups) {
const groupName = group.group;
const isDevelopmentAiAgentsGroup =
tabName === "Development" &&
(groupName === "🤖 For AI Agents" || groupName === "For AI Agents");
if (SKIP_GROUPS.has(groupName) && !isDevelopmentAiAgentsGroup) continue;
if (groupName.trim() === "") continue;

walkPages(group.pages || [], tabName, [groupName], allPages);
}
}
}

return allPages;
}

function walkPages(entries, tabName, groupPath, pages) {
for (const entry of entries) {
if (typeof entry === "string") {
if (shouldSkip(entry)) continue;
if (LLMS_INDEX_SKIP_REFS.has(entry)) continue;
// Skip llms-txt/llms-txt-full pages
if (entry.includes("llms-txt") || entry.includes("llms-full-txt") || entry.includes("llms/")) continue;
// Skip agent-llms pages
if (entry.includes("agent-llms")) continue;
const mdxPath = resolveMdxPath(entry);
if (!mdxPath) continue;
const url = pageRefToUrl(entry);
const rawContent = fs.readFileSync(mdxPath, "utf8");
const fm = parseFrontmatter(rawContent);
const title =
fm?.sidebarTitle || fm?.title || path.basename(entry, ".mdx");
const description = fm?.description || "";
const content = stripMdxComponents(stripFrontmatter(rawContent));

pages.push({
tab: tabName,
groupPath,
pageRef: entry,
mdxPath,
url,
title,
description,
content,
});
} else if (entry.group && entry.pages) {
walkPages(entry.pages, tabName, [...groupPath, entry.group], pages);
} else if (entry.groups) {
for (const g of entry.groups) {
walkPages(g.pages || [], tabName, groupPath, pages);
}
}
}
}

// Organize walked pages by tab → first-level group, preserving nav order.
function groupPagesByTab(pages) {
const tabGroups = {};
for (const page of pages) {
const tab = page.tab;
const group = page.groupPath[0] || "(ungrouped)";
if (!tabGroups[tab]) tabGroups[tab] = {};
if (!tabGroups[tab][group]) tabGroups[tab][group] = [];
tabGroups[tab][group].push(page);
}
return tabGroups;
}

// Organize pages by tab+subsection → inner group, preserving nav order.
// groupPath[0] is always the subsection (menu item or top-level group);
// groupPath[1], when present, is the heading group inside it.
function groupPagesBySubsection(pages) {
const map = new Map();
for (const page of pages) {
const sub = page.groupPath[0] || "(ungrouped)";
const inner = page.groupPath[1] || "";
const key = subKey(page.tab, sub);
if (!map.has(key)) map.set(key, new Map());
const innerMap = map.get(key);
if (!innerMap.has(inner)) innerMap.set(inner, []);
innerMap.get(inner).push(page);
}
return map;
}

// ---------------------------------------------------------------------------
// Collect OpenAPI specs from docs.json
// ---------------------------------------------------------------------------

// Turn a spec ref like "call-control-commands/dial.yml" or a full S3 URL
// ending in "ai/inference.yml" into a human-friendly label
// ("Call Control Commands — Dial"). Falls back to nav-tree context if the
// immediate label is just "API Reference".
function deriveSpecName(ref, ctx) {
if (ctx.group && ctx.group !== "API Reference") return ctx.group;
const lastTwo = ref.replace(/\.(ya?ml|json)$/i, "").split("/").slice(-2);
const ACRONYMS = new Set(["ai", "api", "sip", "stt", "tts", "sms", "mms", "rcs", "uac", "ip", "url", "id"]);
const toTitle = (s) =>
s
.replace(/[-_]+/g, " ")
.split(" ")
.filter(Boolean)
.map((w) => (ACRONYMS.has(w) ? w.toUpperCase() : w[0].toUpperCase() + w.slice(1)))
.join(" ");
if (lastTwo.length === 2) return `${toTitle(lastTwo[0])} — ${toTitle(lastTwo[1])}`;
return toTitle(lastTwo[0] || "API");
}

// Walk the navigation tree and collect every `openapi:` reference. Each tab
// is visited one subsection (menu item / top-level group) at a time so every
// spec is attributed to the subsection it sits under, in addition to its tab.
function collectOpenApiSpecs(docsJson) {
const specs = [];
const seen = new Set();

const collectOperationRefs = (pages, refs = new Set()) => {
if (!pages) return refs;
if (Array.isArray(pages)) {
for (const page of pages) collectOperationRefs(page, refs);
} else if (
typeof pages === "string" &&
/^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS)\s+\//.test(pages)
) {
refs.add(pages);
} else if (typeof pages === "object") {
collectOperationRefs(pages.pages, refs);
collectOperationRefs(pages.groups, refs);
}
return refs;
};

const visit = (node, ctx) => {
if (!node || typeof node !== "object") return;

if (Array.isArray(node)) {
for (const child of node) visit(child, ctx);
return;
}

// Update context as we descend (subsection is fixed at the seed level)
const nextCtx = { ...ctx };
if (node.tab) nextCtx.tab = node.tab;
if (node.group && !SKIP_GROUPS.has(node.group)) nextCtx.group = node.group;
if (node.item && !SKIP_GROUPS.has(node.item)) nextCtx.group = node.item;

// Bail out of skipped subtrees entirely
if ((node.group && SKIP_GROUPS.has(node.group)) || (node.item && SKIP_GROUPS.has(node.item))) {
return;
}

// Accept both remote URLs and local repo paths (e.g. "openapi/voice-clones.yml")
if (typeof node.openapi === "string" && /\.(ya?ml|json)$/i.test(node.openapi)) {
const operationRefs = [...collectOperationRefs(node.pages)].sort();
const specKey = JSON.stringify([
node.openapi,
nextCtx.tab || "API",
nextCtx.subsection || null,
operationRefs,
]);
if (!seen.has(specKey)) {
seen.add(specKey);
specs.push({
name: deriveSpecName(node.openapi, nextCtx),
url: node.openapi,
tab: nextCtx.tab || "API",
subsection: nextCtx.subsection || null,
operationRefs,
});
}
}

for (const value of Object.values(node)) {
if (value && typeof value === "object") visit(value, nextCtx);
}
};

for (const tab of docsJson.navigation?.tabs || []) {
const tabName = tab.tab;
if (tab.menu) {
for (const m of tab.menu) {
if (m.item && SKIP_GROUPS.has(m.item)) continue;
visit(m, { tab: tabName, subsection: m.item || null });
}
} else if (tab.groups) {
for (const g of tab.groups) {
if (g.group && SKIP_GROUPS.has(g.group)) continue;
visit(g, { tab: tabName, subsection: g.group || null });
}
} else {
visit(tab, { tab: tabName, subsection: null });
}
}
return specs;
}

// ---------------------------------------------------------------------------
// Expand OpenAPI specs into per-operation entries
// ---------------------------------------------------------------------------

const HTTP_METHODS = ["get", "post", "put", "patch", "delete", "head", "options"];

async function loadSpec(ref) {
// Local repo paths (e.g. "openapi/voice-clones.yml") vs remote URLs.
if (ref.startsWith("https://") || ref.startsWith("http://")) {
const res = await fetch(ref);
if (!res.ok) throw new Error(`HTTP ${res.status} for ${ref}`);
return yaml.load(await res.text());
}
const localPath = path.isAbsolute(ref) ? ref : path.join(REPO_ROOT, ref);
return yaml.load(fs.readFileSync(localPath, "utf8"));
}

function firstLine(s) {
if (!s) return "";
return s.split("\n")[0].trim();
}

function collectOperationsFromSpec(doc, sourceUrl) {
const operations = [];
const pushOp = (op, method, operationPath) => {
if (!op || !op.summary) return;
const rawTag = op.tags?.[0];
if (!rawTag) return;
const tagSlug = slugifyOpenApi(rawTag);
const opSlug = slugifyOpenApi(op.summary);
if (!tagSlug || !opSlug) return;
operations.push({
tag: rawTag,
tagSlug,
operationId: op.operationId || "",
title: op.summary,
description: firstLine(op.description),
url: `/api-reference/${tagSlug}/${opSlug}`,
sourceSpec: sourceUrl,
operationRef: `${method.toUpperCase()} ${operationPath}`,
});
};

for (const [operationPath, methods] of Object.entries(doc.paths || {})) {
for (const m of HTTP_METHODS) pushOp(methods?.[m], m, operationPath);
}
// OpenAPI 3.1 webhooks → /api-reference/callbacks/* pages on the live site
for (const [operationPath, methods] of Object.entries(doc.webhooks || {})) {
for (const m of HTTP_METHODS) pushOp(methods?.[m], m, operationPath);
}
return operations;
}

function operationsForSpec(doc, spec) {
const allowedOperations = new Set(spec.operationRefs || []);
return collectOperationsFromSpec(doc, spec.url).filter(
(op) => allowedOperations.size === 0 || allowedOperations.has(op.operationRef)
);
}

/**
* Load every spec once and return:
* allOps – globally deduped operations (for the API Reference shards)
* opsByTab – tab name → operations from that tab's specs, deduped within
* the tab (a shared spec like Callbacks may appear under
* several tabs; each per-section file stays self-contained)
* opsBySub – subKey(tab, subsection) → operations from that subsection's
* specs, deduped within the subsection
*/
async function expandOpenApiOperations(openApiSpecs) {
const allOps = [];
const seenGlobal = new Set();
const opsByTab = new Map();
const seenByTab = new Map();
const opsBySub = new Map();
const seenBySub = new Map();
const loadedSpecs = new Map();

for (const spec of openApiSpecs) {
let doc;
try {
if (!loadedSpecs.has(spec.url)) loadedSpecs.set(spec.url, await loadSpec(spec.url));
doc = loadedSpecs.get(spec.url);
} catch (e) {
console.warn(` ⚠ Failed to load ${spec.url}: ${e.message}`);
continue;
}
for (const op of operationsForSpec(doc, spec)) {
if (!seenGlobal.has(op.url)) {
seenGlobal.add(op.url);
allOps.push(op);
}
const tab = spec.tab;
if (!opsByTab.has(tab)) {
opsByTab.set(tab, []);
seenByTab.set(tab, new Set());
}
if (!seenByTab.get(tab).has(op.url)) {
seenByTab.get(tab).add(op.url);
opsByTab.get(tab).push(op);
}
if (spec.subsection) {
const key = subKey(spec.tab, spec.subsection);
if (!opsBySub.has(key)) {
opsBySub.set(key, []);
seenBySub.set(key, new Set());
}
if (!seenBySub.get(key).has(op.url)) {
seenBySub.get(key).add(op.url);
opsBySub.get(key).push(op);
}
}
}
}
return { allOps, opsByTab, opsBySub };
}

// Group a list of operations by their first tag, preserving order.
function groupOpsByTag(ops) {
const byTag = new Map();
for (const op of ops) {
if (!byTag.has(op.tag)) byTag.set(op.tag, []);
byTag.get(op.tag).push(op);
}
return byTag;
}

// ---------------------------------------------------------------------------
// Output generation — API Reference shards (deployed to S3 under llms/)
// ---------------------------------------------------------------------------

// Number of shards is chosen so each stays under the 50K target from
// AFDocs's "split into sub-files, each under 50,000 characters"
// recommendation. 1050 ops × ~95 chars ≈ 100K total, so 3 shards leaves
// comfortable headroom even as the API surface grows.
const API_REFERENCE_SHARDS = 3;

function shardApiOperationsByTag(apiOperations) {
// Group by tag in sorted order so a tag's operations never split across
// shards (keeps each tag's content discoverable in one fetch).
const byTag = groupOpsByTag(apiOperations);
const tags = [...byTag.keys()].sort((a, b) => {
if (a === "Callbacks") return 1;
if (b === "Callbacks") return -1;
return a.localeCompare(b);
});

// Pre-compute estimated byte cost of each tag's bullet block so we can
// greedily pack tags into shards of roughly equal size.
const tagCost = (tag) =>
`## ${tag}\n\n`.length +
byTag.get(tag).reduce((s, op) => s + `- [${op.title}](${BASE_URL}${op.url}.md)\n`.length, 0) +
1; // trailing newline

const totalCost = tags.reduce((s, t) => s + tagCost(t), 0);
const targetPerShard = Math.ceil(totalCost / API_REFERENCE_SHARDS);

const shards = Array.from({ length: API_REFERENCE_SHARDS }, () => []);
let shardIdx = 0;
let shardCost = 0;
for (const tag of tags) {
const cost = tagCost(tag);
if (shardCost + cost > targetPerShard && shardIdx < API_REFERENCE_SHARDS - 1) {
shardIdx++;
shardCost = 0;
}
shards[shardIdx].push(tag);
shardCost += cost;
}

return { byTag, shards };
}

function generateApiReferenceShardText(shardIndex, shardTags, byTag, totalShards) {
const firstTag = shardTags[0];
const lastTag = shardTags[shardTags.length - 1];
let out = "";
out += `# Telnyx API Reference — Part ${shardIndex + 1} of ${totalShards}\n`;
out += `> Per-operation index for Telnyx REST API endpoints (tags: ${firstTag} → ${lastTag}).\n`;
out += `> For the documentation index, see [llms.txt](${BASE_URL}/llms.txt). For the full consolidated spec, see [spec3.json](${CONSOLIDATED_OPENAPI_SPEC_URL}).\n\n`;
for (const tag of shardTags) {
out += `## ${tag}\n\n`;
for (const op of byTag.get(tag)) {
out += `- [${op.title}](${BASE_URL}${op.url}.md)\n`;
}
out += "\n";
}
return out;
}

function apiReferenceShardFile(shardIndex) {
return `api-reference-${shardIndex + 1}.txt`;
}

// ---------------------------------------------------------------------------
// Output generation — root llms.txt (nested index, committed to repo)
// ---------------------------------------------------------------------------

function generateRootLlmsIndex(docsJson, includedSubs) {
const siteName = docsJson.name || "Telnyx";
const siteDescription = docsJson.description || "";

let out = "";
out += `# ${siteName}\n`;
out += `> ${siteDescription}\n\n`;
out += `Telnyx developer documentation (${BASE_URL}), split into per-section and per-subsection files so agents can load only the relevant product area. Each section links a concise index (page links and descriptions, plus that section's API endpoints) and a \`-full.txt\` file carrying complete page content; the nested bullets are focused subsection files.\n\n`;
out += USE_CASES_MD + WHY_TELNYX_MD + CONSTRAINTS_MD + FOR_AGENTS_MD;

out += `## Documentation sections\n\n`;
for (const tabName of TAB_ORDER) {
const desc = TAB_DESCRIPTIONS[tabName] || "";
out += `- [${tabName}](${tabIndexUrl(tabName)}): ${desc} ([full content](${tabFullUrl(tabName)}))\n`;
for (const subName of includedSubs.get(tabName) || []) {
out += ` - [${subName}](${subIndexUrl(tabName, subName)}) ([full](${subFullUrl(tabName, subName)}))\n`;
}
}
out += "\n";

// Pricing — agents need discoverable pricing to relay recommendations.
out += `## Pricing\n\n`;
out += `- [Pricing overview](${BASE_URL}/pricing.md): Pay-as-you-go rates for voice, messaging, phone numbers, wireless, AI inference, networking, and storage — full rate tables at https://telnyx.com/pricing and machine-readable pricing at https://telnyx.com/pricing.md.\n\n`;

// OpenAPI Specification — single link to the consolidated spec.
out += `## OpenAPI Specification\n\n`;
out += `- [Telnyx OpenAPI Specification (consolidated)](${CONSOLIDATED_OPENAPI_SPEC_URL}): Single OpenAPI 3.1 JSON covering every Telnyx REST API surface — paths, schemas, and webhooks.\n\n`;

return out;
}

// ---------------------------------------------------------------------------
// Output generation — per-section and per-subsection intermediate files
// ---------------------------------------------------------------------------

function appendApiReference(out, label, ops) {
if (!ops || ops.length === 0) return out;
const byTag = groupOpsByTag(ops);
out += `## API Reference (${label})\n\n`;
for (const [tag, tagOps] of byTag) {
out += `### ${tag}\n\n`;
for (const op of tagOps) {
// First line of the operation's spec description — gives agents a
// quotable summary per endpoint. Markdown links are flattened to
// their text so truncation can't leave broken syntax. Shards skip
// these to stay <50K.
const d = shortDescription(
(op.description || "").replace(/\[([^\]]*)\]$[^)]*$/g, "$1"),
160
);
out += d
? `- [${op.title}](${BASE_URL}${op.url}.md): ${d}\n`
: `- [${op.title}](${BASE_URL}${op.url}.md)\n`;
}
out += "\n";
}
return out;
}

function generateTabLlmsTxt(tabName, groups, tabOps, tabSubs) {
const desc = TAB_DESCRIPTIONS[tabName] || "";
let out = "";
out += `# Telnyx ${tabName} — Documentation Index\n`;
out += `> ${desc}. One section of the Telnyx developer docs (${BASE_URL}).\n`;
out += `> Root index: ${BASE_URL}/llms.txt · Full content for this section: ${tabFullUrl(tabName)}\n\n`;

if (tabSubs && tabSubs.length > 0) {
out += `## Subsections\n\n`;
out += `Focused per-subsection files (index + full content):\n\n`;
for (const subName of tabSubs) {
out += `- [${subName}](${subIndexUrl(tabName, subName)}) ([full](${subFullUrl(tabName, subName)}))\n`;
}
out += "\n";
}

for (const [groupName, groupPages] of Object.entries(groups)) {
if (Object.keys(groups).length > 1) {
out += `## ${groupName}\n\n`;
}
for (const page of groupPages) {
const d = shortDescription(page.description);
out += d
? `- [${page.title}](${toMdUrl(page.url)}): ${d}\n`
: `- [${page.title}](${toMdUrl(page.url)})\n`;
}
out += "\n";
}

return appendApiReference(out, tabName, tabOps);
}

function generateTabLlmsFullTxt(tabName, groups, tabOps) {
const desc = TAB_DESCRIPTIONS[tabName] || "";
let out = "";
out += `# Telnyx ${tabName} — Full Documentation\n`;
out += `> ${desc}. Complete page content for the ${tabName} section of the Telnyx developer docs (${BASE_URL}).\n`;
out += `> Root index: ${BASE_URL}/llms.txt · Lightweight index for this section: ${tabIndexUrl(tabName)}\n\n`;

for (const [groupName, groupPages] of Object.entries(groups)) {
out += `## ${groupName}\n\n`;
for (const page of groupPages) {
out += `### ${page.title}\n\n`;
if (page.url) {
out += `> Source: ${toMdUrl(page.url)}\n\n`;
}
out += page.content;
out += "\n\n---\n\n";
}
}

// Endpoint pages are generated from OpenAPI specs (no MDX source), so the
// full file links them rather than inlining.
return appendApiReference(out, tabName, tabOps);
}

function generateSubLlmsTxt(tabName, subName, innerGroups, subOps) {
let out = "";
out += `# Telnyx ${tabName}: ${subName} — Documentation Index\n`;
out += `> ${subName} documentation within the ${tabName} section of the Telnyx developer docs (${BASE_URL}).\n`;
out += `> Root index: ${BASE_URL}/llms.txt · ${tabName} index: ${tabIndexUrl(tabName)} · Full content for this subsection: ${subFullUrl(tabName, subName)}\n\n`;

const namedInner = [...innerGroups.keys()].filter((n) => n);
const useHeadings = namedInner.length > 1 || innerGroups.size > 1;
for (const [innerName, innerPages] of innerGroups) {
if (useHeadings && innerName) {
out += `## ${innerName}\n\n`;
}
for (const page of innerPages) {
const d = shortDescription(page.description);
out += d
? `- [${page.title}](${toMdUrl(page.url)}): ${d}\n`
: `- [${page.title}](${toMdUrl(page.url)})\n`;
}
out += "\n";
}

return appendApiReference(out, subName, subOps);
}

function generateSubLlmsFullTxt(tabName, subName, innerGroups, subOps) {
let out = "";
out += `# Telnyx ${tabName}: ${subName} — Full Documentation\n`;
out += `> Complete page content for ${subName} (${tabName} section) of the Telnyx developer docs (${BASE_URL}).\n`;
out += `> Root index: ${BASE_URL}/llms.txt · Lightweight index for this subsection: ${subIndexUrl(tabName, subName)}\n\n`;

for (const [innerName, innerPages] of innerGroups) {
if (innerName) {
out += `## ${innerName}\n\n`;
}
for (const page of innerPages) {
out += `### ${page.title}\n\n`;
if (page.url) {
out += `> Source: ${toMdUrl(page.url)}\n\n`;
}
out += page.content;
out += "\n\n---\n\n";
}
}

return appendApiReference(out, subName, subOps);
}

// ---------------------------------------------------------------------------
// Output generation — site-wide llms-full.txt (committed to repo)
// ---------------------------------------------------------------------------

function generateLlmsFullTxt(docsJson, includedSubs) {
const siteName = docsJson.name || "Telnyx";
const siteDescription = docsJson.description || "";

let out = "";
out += `# ${siteName} — Full Documentation\n`;
out += `> ${siteDescription}\n\n`;
out += `Complete Telnyx developer documentation, split into per-area full-content files (the combined corpus is ~3.4M characters — far past single-request agent limits). Each link below carries the complete page content for its area; this file holds authentication, quickstart examples, and the map. Lightweight per-area indexes are listed in [llms.txt](${BASE_URL}/llms.txt).\n\n`;
out += USE_CASES_MD + CONSTRAINTS_MD + FOR_AGENTS_MD + AUTH_QUICKSTART_MD;

out += `## Per-area full documentation\n\n`;
for (const tabName of TAB_ORDER) {
out += `- [${tabName} — full content](${tabFullUrl(tabName)}): ${TAB_DESCRIPTIONS[tabName] || ""}\n`;
for (const subName of includedSubs.get(tabName) || []) {
out += ` - [${subName} — full content](${subFullUrl(tabName, subName)})\n`;
}
}
out += `\n## OpenAPI Specification\n\n`;
out += `- [Telnyx OpenAPI Specification (consolidated)](${CONSOLIDATED_OPENAPI_SPEC_URL}): Single OpenAPI 3.1 JSON covering every Telnyx REST API surface.\n\n`;
return out;
}

// ---------------------------------------------------------------------------
// Mintlify-native llms pages (committed) — one pair per product/subsection
// ---------------------------------------------------------------------------

function landingBase(tabName, subName) {
return `${TAB_SLUGS[tabName]}-${subsectionSlug(subName)}`;
}

function landingPageRefs(tabName, subName) {
const base = landingBase(tabName, subName);
// Refs MUST end in /index. Mintlify's nav indexer only reads a page's
// frontmatter (title/sidebarTitle) when the docs.json ref explicitly
// targets the index file; a bare directory ref makes the sidebar fall
// back to humanizing the slug ("Calling voice api llms txt"). The
// known-good entries (development/agent-skills/index, the MCP pages)
// all use the explicit /index form. URLs are unchanged — Mintlify
// serves /index at /.
return [
`development/llms/${base}-llms-txt/index`,
`development/llms/${base}-llms-full-txt/index`,
];
}

// Generated llms content is valid Markdown but may contain JSX-like tags or
// bare object examples that MDX would interpret. Preserve Markdown structure
// while escaping only MDX-significant characters outside fenced code blocks.
function makeGeneratedContentMdxSafe(content) {
let fence = null;
return content
.split("\n")
.map((line) => {
line = line.replace(/\t/g, " ").replace(/[ \t]+$/, "");
const marker = line.match(/^\s*(`{3,}|~{3,})/);
if (marker) {
if (!fence) fence = marker[1][0];
else if (fence === marker[1][0]) fence = null;
return line;
}
if (fence) return line;
return line
.replace(/.txt artifacts.
const slug = TAB_SLUGS[tabName];
const [tabTxtDir, tabFullDir] = tabLandingDirs(tabName);
fs.mkdirSync(tabTxtDir, { recursive: true });
fs.mkdirSync(tabFullDir, { recursive: true });
fs.writeFileSync(
path.join(tabTxtDir, "index.mdx"),
generateTabLandingTxtMdx(tabName, readLlmsArtifact(`${slug}.txt`)),
"utf8"
);
fs.writeFileSync(
path.join(tabFullDir, "index.mdx"),
generateTabLandingFullMdx(tabName, readLlmsArtifact(`${slug}-full.txt`)),
"utf8"
);
count += 2;

for (const subName of subs) {
const base = landingBase(tabName, subName);
const txtDir = path.join(LANDING_DIR, `${base}-llms-txt`);
const fullDir = path.join(LANDING_DIR, `${base}-llms-full-txt`);
fs.mkdirSync(txtDir, { recursive: true });
fs.mkdirSync(fullDir, { recursive: true });
const subSlug = subsectionSlug(subName);
fs.writeFileSync(
path.join(txtDir, "index.mdx"),
generateLandingTxtMdx(tabName, subName, readLlmsArtifact(slug, `${subSlug}.txt`)),
"utf8"
);
fs.writeFileSync(
path.join(fullDir, "index.mdx"),
generateLandingFullMdx(tabName, subName, readLlmsArtifact(slug, `${subSlug}-full.txt`)),
"utf8"
);
count += 2;
}
}
return count;
}

// ---------------------------------------------------------------------------
// docs.json sidebar updater — "For AI Agents" group in every subsection
// ---------------------------------------------------------------------------

const AI_AGENTS_GROUP = "For AI Agents";
// Names to recognize when removing previously generated groups — includes the
// legacy emoji-prefixed form so a rename never leaves duplicates behind.
const AI_AGENTS_GROUP_NAMES = new Set([AI_AGENTS_GROUP, "🤖 For AI Agents"]);

// Tabs whose llms sidebar is consolidated into their single top-level
// "For AI Agents" group. All generated pages still need a navigation entry;
// Mintlify does not publish repository pages that are absent from docs.json.
const SIDEBAR_CONSOLIDATED_TABS = new Set(["Development", "Other APIs"]);

function allLandingPageRefs(tabName, subs) {
return [
...(tabName === "Development"
? ["development/llms-txt/index", "development/llms-txt-full/index"]
: tabLandingRefs(tabName)),
...subs.flatMap((subName) => landingPageRefs(tabName, subName)),
];
}

function isGeneratedLlmsPageRef(page) {
return (
typeof page === "string" &&
(page.startsWith("development/llms/") ||
page === "development/llms-txt/index" ||
page === "development/llms-txt-full/index")
);
}

// Idempotent: existing per-subsection AI-agents groups are rebuilt from
// scratch on every run, so renames/removals never leave stale entries.
// The Development tab's top-level "For AI Agents" group (root llms.txt
// landing pages, MCP, agent skills) is preserved untouched — SKIP_GROUPS
// keeps it out of the subsection list.
function updateDocsJsonSidebar(includedSubs) {
const raw = fs.readFileSync(DOCS_JSON_PATH, "utf8");
const docsJson = JSON.parse(raw);
let updated = 0;

for (const tab of docsJson.navigation?.tabs || []) {
const tabName = tab.tab;
const subs = new Set(includedSubs.get(tabName) || []);
const consolidated = SIDEBAR_CONSOLIDATED_TABS.has(tabName);
let addedTabLandingPages = false;

if (tab.menu) {
for (const m of tab.menu) {
const n = m.item;
if (!n || !subs.has(n)) continue;
m.groups = (m.groups || []).filter((g) => !AI_AGENTS_GROUP_NAMES.has(g.group));
if (consolidated) continue;
const pages = landingPageRefs(tabName, n);
if (!addedTabLandingPages) {
pages.unshift(...tabLandingRefs(tabName));
addedTabLandingPages = true;
}
m.groups.push({ group: AI_AGENTS_GROUP, pages });
updated++;
}
} else if (tab.groups) {
for (const g of tab.groups) {
const n = g.group;
if (!n || !subs.has(n)) continue;
g.pages = (g.pages || []).filter(
(p) => !(p && typeof p === "object" && AI_AGENTS_GROUP_NAMES.has(p.group))
);
if (consolidated) continue;
const pages = landingPageRefs(tabName, n);
if (!addedTabLandingPages) {
pages.unshift(...tabLandingRefs(tabName));
addedTabLandingPages = true;
}
g.pages.push({ group: AI_AGENTS_GROUP, pages });
updated++;
}
}

// Consolidated tabs publish every generated route from one top-level group.
// Preserve hand-managed Development entries such as MCP and Agent Skills.
if (consolidated && tab.groups && subs.size > 0) {
const existing = tab.groups.find((g) => AI_AGENTS_GROUP_NAMES.has(g.group));
const generatedPages = allLandingPageRefs(tabName, [...subs]);
if (existing) {
existing.group = AI_AGENTS_GROUP;
existing.pages = [
...(existing.pages || []).filter((page) => !isGeneratedLlmsPageRef(page)),
...generatedPages,
];
} else {
tab.groups.push({ group: AI_AGENTS_GROUP, pages: generatedPages });
}
updated++;
}
}

fs.writeFileSync(DOCS_JSON_PATH, JSON.stringify(docsJson, null, 2) + "\n", "utf8");
return updated;
}

// ---------------------------------------------------------------------------
// Cleanup old files
// ---------------------------------------------------------------------------

function cleanupOldFiles() {
// Remove old per-group public/llms/ directories
const llmsDir = path.join(PUBLIC_DIR, "llms");
if (fs.existsSync(llmsDir)) {
fs.rmSync(llmsDir, { recursive: true });
console.log(" ✓ Deleted old public/llms/");
}

// Remove old public/development/ files
const devDir = path.join(PUBLIC_DIR, "development");
if (fs.existsSync(devDir)) {
fs.rmSync(devDir, { recursive: true });
console.log(" ✓ Deleted old public/development/");
}

// Remove old per-group MDX directories
const oldDirs = [
path.join(REPO_ROOT, "development", "agent-llms-full-txt"),
path.join(REPO_ROOT, "development", "agent-llms-txt"),
];
for (const dir of oldDirs) {
if (fs.existsSync(dir)) {
fs.rmSync(dir, { recursive: true });
console.log(` ✓ Deleted old ${path.relative(REPO_ROOT, dir)}/`);
}
}

// Remove legacy .well-known API Reference shards — Mintlify never served
// .txt files from .well-known/ (only .json/.yaml static assets work).
const wellKnownDir = path.join(REPO_ROOT, ".well-known");
if (fs.existsSync(wellKnownDir)) {
for (const name of fs.readdirSync(wellKnownDir)) {
if (/^api-reference-\d+-llms\.txt$/.test(name)) {
fs.rmSync(path.join(wellKnownDir, name));
console.log(` ✓ Deleted legacy .well-known/${name}`);
}
}
}

// Landing pages and llms-out/ are fully generated — reset both so renamed
// or removed subsections never leave stale files behind.
if (fs.existsSync(LANDING_DIR)) {
fs.rmSync(LANDING_DIR, { recursive: true });
}
if (fs.existsSync(LLMS_OUT_DIR)) {
fs.rmSync(LLMS_OUT_DIR, { recursive: true });
}
}

// ---------------------------------------------------------------------------
// NLWeb schema map — lists the machine-readable feeds for this domain.
// Mirrors the format already serving (and passing checks) at
// https://telnyx.com/schemamap.xml. Referenced from robots.txt.
// ---------------------------------------------------------------------------

function generateSchemamapXml(includedSubs) {
const lastmod = new Date().toISOString().replace(/\.\d{3}Z$/, "Z");
const entry = (loc, contentType, priority, changefreq) =>
` \n` +
` ${loc}\n` +
` ${lastmod}\n` +
` ${changefreq}\n` +
` ${priority}\n` +
` \n`;

let out = `\n`;
out += `\n`;
out += entry(`${BASE_URL}/llms.txt`, "structuredData/llms-txt", "1.0", "daily");
out += entry(`${BASE_URL}/llms-full.txt`, "structuredData/llms-txt", "0.9", "daily");
for (const tabName of TAB_ORDER) {
out += entry(tabIndexUrl(tabName), "structuredData/llms-txt", "0.8", "daily");
out += entry(tabFullUrl(tabName), "structuredData/llms-txt", "0.7", "daily");
}
out += entry(`${BASE_URL}/pricing.md`, "structuredData/markdown", "0.9", "daily");
out += entry(`${BASE_URL}/auth.md`, "structuredData/markdown", "0.9", "weekly");
out += entry(`${BASE_URL}/compare.md`, "structuredData/markdown", "0.7", "weekly");
out += entry(`${BASE_URL}/docs/overview.md`, "structuredData/markdown", "0.8", "weekly");
out += entry(CONSOLIDATED_OPENAPI_SPEC_URL, "structuredData/openapi", "0.9", "daily");
out += entry(`${BASE_URL}/.well-known/agent-card.json`, "structuredData/agent-card", "0.8", "weekly");
out += `\n`;
return out;
}

// ---------------------------------------------------------------------------
// Main
// ---------------------------------------------------------------------------

async function main() {
console.log("Reading docs.json...");
const docsJson = readDocsJson();

console.log("Walking navigation tree...");
const pages = walkNavigation(docsJson);
console.log(`Found ${pages.length} documentation pages`);

// Count per tab
const tabCounts = {};
for (const page of pages) {
tabCounts[page.tab] = (tabCounts[page.tab] || 0) + 1;
}
for (const [tab, count] of Object.entries(tabCounts)) {
console.log(` ${tab}: ${count} pages`);
}

// Subsections per tab, straight from docs.json
const subsByTab = deriveSubsections(docsJson);

// Collect OpenAPI specs (with tab + subsection attribution)
const openApiSpecs = collectOpenApiSpecs(docsJson);
console.log(`Found ${openApiSpecs.length} OpenAPI specs`);

// Expand each spec into per-operation entries (paths + 3.1 webhooks)
console.log("Expanding OpenAPI specs into per-operation entries...");
const { allOps, opsByTab, opsBySub } = await expandOpenApiOperations(openApiSpecs);
console.log(` Found ${allOps.length} operations across all specs`);

// Ensure output directories exist
if (!fs.existsSync(PUBLIC_DIR)) {
fs.mkdirSync(PUBLIC_DIR, { recursive: true });
}

// Clean up old files (also resets llms-out/ and development/llms/)
console.log("\nCleaning up old files...");
cleanupOldFiles();
fs.mkdirSync(LLMS_OUT_DIR, { recursive: true });

const tabGroups = groupPagesByTab(pages);
const pagesBySub = groupPagesBySubsection(pages);

// Subsections that actually have content (pages or endpoints). Empty ones
// get no files, no sidebar entries, and no root index lines.
const includedSubs = new Map();
for (const tabName of TAB_ORDER) {
const subs = [];
for (const subName of subsByTab.get(tabName) || []) {
const key = subKey(tabName, subName);
const hasPages = pagesBySub.has(key);
const hasOps = (opsBySub.get(key) || []).length > 0;
if (hasPages || hasOps) {
subs.push(subName);
} else {
console.warn(` ⚠ Subsection "${tabName} → ${subName}" has no pages or endpoints — skipping`);
}
}
includedSubs.set(tabName, subs);
}

// ---------------------------------------------------------------
// Per-section and per-subsection files → llms-out/
// ---------------------------------------------------------------
console.log("\nGenerating per-section files in llms-out/...");
let subFileCount = 0;
for (const tabName of TAB_ORDER) {
const groups = tabGroups[tabName];
if (!groups) {
console.warn(` ⚠ No pages found for tab "${tabName}" — skipping`);
continue;
}
const tabOps = opsByTab.get(tabName) || [];
const slug = TAB_SLUGS[tabName];
const tabSubs = includedSubs.get(tabName) || [];

const indexText = generateTabLlmsTxt(tabName, groups, tabOps, tabSubs);
fs.writeFileSync(path.join(LLMS_OUT_DIR, `${slug}.txt`), indexText, "utf8");
const indexKb = (Buffer.byteLength(indexText, "utf8") / 1024).toFixed(1);

const fullText = generateTabLlmsFullTxt(tabName, groups, tabOps);
fs.writeFileSync(path.join(LLMS_OUT_DIR, `${slug}-full.txt`), fullText, "utf8");
const fullKb = (Buffer.byteLength(fullText, "utf8") / 1024).toFixed(1);

console.log(` → ${slug}.txt (${indexKb} KB) + ${slug}-full.txt (${fullKb} KB)`);

// Subsection files in llms-out//
if (tabSubs.length > 0) {
const tabDir = path.join(LLMS_OUT_DIR, slug);
fs.mkdirSync(tabDir, { recursive: true });
for (const subName of tabSubs) {
const key = subKey(tabName, subName);
const innerGroups = pagesBySub.get(key) || new Map();
const subOps = opsBySub.get(key) || [];
const subSlug = subsectionSlug(subName);

const subIndex = generateSubLlmsTxt(tabName, subName, innerGroups, subOps);
fs.writeFileSync(path.join(tabDir, `${subSlug}.txt`), subIndex, "utf8");

const subFull = generateSubLlmsFullTxt(tabName, subName, innerGroups, subOps);
fs.writeFileSync(path.join(tabDir, `${subSlug}-full.txt`), subFull, "utf8");

subFileCount += 2;
const iKb = (Buffer.byteLength(subIndex, "utf8") / 1024).toFixed(1);
const fKb = (Buffer.byteLength(subFull, "utf8") / 1024).toFixed(1);
console.log(` ↳ ${slug}/${subSlug}.txt (${iKb} KB) + ${slug}/${subSlug}-full.txt (${fKb} KB)`);
}
}
}
console.log(` Subsection files: ${subFileCount}`);

// Schema map → llms-out/ (served at telnyx.com/llms/schemamap.xml,
// referenced from robots.txt per the NLWeb Schema Feeds convention)
fs.writeFileSync(path.join(LLMS_OUT_DIR, "schemamap.xml"), generateSchemamapXml(includedSubs), "utf8");
console.log(" → schemamap.xml");

// API Reference shards → llms-out/
console.log("\nGenerating API Reference shards in llms-out/...");
const { byTag, shards } = shardApiOperationsByTag(allOps);
shards.forEach((tags, i) => {
const text = generateApiReferenceShardText(i, tags, byTag, shards.length);
fs.writeFileSync(path.join(LLMS_OUT_DIR, apiReferenceShardFile(i)), text, "utf8");
const size = Buffer.byteLength(text, "utf8");
console.log(` → ${apiReferenceShardFile(i)} (${(size / 1024).toFixed(1)} KB, ${tags.length} tags)`);
if (size >= ROOT_INDEX_MAX_CHARS) {
console.warn(` ⚠ ${apiReferenceShardFile(i)} exceeds 50K — bump API_REFERENCE_SHARDS`);
}
});

// ---------------------------------------------------------------
// Root llms.txt (nested index) + site-wide llms-full.txt,
// committed to the repo. Mintlify serves these two names at the
// site root (custom files override its auto-generated versions);
// the copies under public/ are the only other .txt paths it serves.
// ---------------------------------------------------------------
// Static snippet: 207 production-ready Python code examples from
// team-telnyx/telnyx-code-examples. Appended to both root files so the
// examples survive regeneration. Update the snippet file to add/remove
// examples — no script changes needed.
const codeExamplesSnippet = fs.readFileSync(
path.join(__dirname, "code-examples-llms-snippet.md"),
"utf8"
).trimEnd();

console.log("\nGenerating root llms.txt (nested index)...");
const rootIndex = generateRootLlmsIndex(docsJson, includedSubs) + "\n" + codeExamplesSnippet + "\n";
const rootSize = Buffer.byteLength(rootIndex, "utf8");
if (rootSize >= ROOT_INDEX_MAX_CHARS) {
console.error(` ✗ Root llms.txt is ${rootSize} bytes — must stay under ${ROOT_INDEX_MAX_CHARS}`);
process.exit(1);
}
fs.writeFileSync(path.join(REPO_ROOT, "llms.txt"), rootIndex, "utf8");
fs.writeFileSync(path.join(PUBLIC_DIR, "llms.txt"), rootIndex, "utf8");
console.log(` → llms.txt + public/llms.txt (${(rootSize / 1024).toFixed(1)} KB)`);

console.log("Generating site-wide llms-full.txt...");
const llmsFullTxt = generateLlmsFullTxt(docsJson, includedSubs) + "\n" + codeExamplesSnippet + "\n";
fs.writeFileSync(path.join(REPO_ROOT, "llms-full.txt"), llmsFullTxt, "utf8");
fs.writeFileSync(path.join(PUBLIC_DIR, "llms-full.txt"), llmsFullTxt, "utf8");
const llmsFullTxtSize = (Buffer.byteLength(llmsFullTxt, "utf8") / (1024 * 1024)).toFixed(2);
console.log(` → llms-full.txt + public/llms-full.txt (${llmsFullTxtSize} MB)`);

// ---------------------------------------------------------------
// Sidebar landing pages + docs.json entries (committed)
// ---------------------------------------------------------------
console.log("\nGenerating sidebar landing pages...");
const landingCount = writeLandingPages(includedSubs);
console.log(` → ${landingCount} MDX pages under development/llms/`);

console.log("Updating docs.json sidebar entries...");
const sidebarCount = updateDocsJsonSidebar(includedSubs);
console.log(` → ${sidebarCount} "${AI_AGENTS_GROUP}" subsection groups`);

// Validate docs.json round-trips as JSON
try {
JSON.parse(fs.readFileSync(DOCS_JSON_PATH, "utf8"));
console.log(" ✓ docs.json is valid JSON");
} catch (e) {
console.error(" ✗ docs.json is INVALID JSON:", e.message);
process.exit(1);
}

console.log("\nDone!");
}

module.exports = {
collectOpenApiSpecs,
collectOperationsFromSpec,
operationsForSpec,
};

if (require.main === module) {
main().catch((err) => {
console.error(err);
process.exit(1);
});
}}}}}

​Examples

Examples