mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
159 lines
5.4 KiB
TypeScript
159 lines
5.4 KiB
TypeScript
import { source } from "@/lib/source";
|
|
|
|
const siteOrigin = "https://docs.kaelio.com/ktx";
|
|
|
|
export type LlmDocsPage = {
|
|
title: string;
|
|
description?: string;
|
|
url: string;
|
|
markdownUrl: string;
|
|
slug: string[];
|
|
getMarkdown: () => Promise<string>;
|
|
};
|
|
|
|
export function getLlmDocsPages(): LlmDocsPage[] {
|
|
return source.getPages().map(toLlmDocsPage);
|
|
}
|
|
|
|
export function getLlmDocsPage(slug: string[] | undefined) {
|
|
const page = source.getPage(slug);
|
|
return page ? toLlmDocsPage(page) : null;
|
|
}
|
|
|
|
export async function getPageMarkdown(page: LlmDocsPage) {
|
|
const description = page.description ? `\n\n> ${page.description}` : "";
|
|
const body = await page.getMarkdown();
|
|
|
|
return normalizeMarkdown(`# ${page.title}${description}
|
|
|
|
Canonical URL: ${absoluteUrl(page.url)}
|
|
Markdown URL: ${absoluteUrl(page.markdownUrl)}
|
|
|
|
${body}
|
|
`);
|
|
}
|
|
|
|
export function buildLlmsTxt() {
|
|
const pages = getLlmDocsPages();
|
|
const byUrl = new Map(pages.map((page) => [page.url, page]));
|
|
const link = (url: string, label: string, fallbackDescription: string) => {
|
|
const page = byUrl.get(url);
|
|
const description = page?.description ?? fallbackDescription;
|
|
const markdownUrl = page?.markdownUrl ?? `${url}.md`;
|
|
return `- [${label}](${absoluteUrl(markdownUrl)}): ${description}`;
|
|
};
|
|
|
|
return `# KTX
|
|
|
|
> Agent-native context layer for analytics engineering and database agents.
|
|
|
|
KTX provides semantic-layer files, warehouse scans, knowledge pages, provenance, and agent-facing tools that help coding agents answer analytics questions without inventing metrics or joins.
|
|
|
|
## Agent Entry Points
|
|
|
|
${link("/docs/ai-resources", "AI Resources", "Machine-readable docs, prompt recipes, and agent setup paths")}
|
|
${link("/docs/ai-resources/agent-quickstart", "Agent Quickstart", "Task-first route for coding assistants using KTX")}
|
|
${link("/docs/ai-resources/markdown-access", "Markdown Access", "Fetch KTX docs as llms.txt, llms-full.txt, or per-page Markdown")}
|
|
${link("/docs/ai-resources/agent-instructions", "Agent Instructions", "Suggested instructions for coding assistants that need to read and cite KTX docs")}
|
|
|
|
## Start Here
|
|
|
|
${link("/docs/getting-started/introduction", "Introduction", "What KTX is and who it is for")}
|
|
${link("/docs/getting-started/quickstart", "Quickstart", "Set up KTX and build your first context")}
|
|
${link("/docs/guides/writing-context", "Writing Context", "Write semantic sources and knowledge pages")}
|
|
|
|
## Machine-Readable Documentation
|
|
|
|
- [Full documentation](${absoluteUrl("/llms-full.txt")}): All docs pages in one plain-text markdown response
|
|
- [Markdown access guide](${absoluteUrl("/docs/ai-resources/markdown-access.md")}): How to fetch llms.txt, llms-full.txt, and per-page Markdown
|
|
- [Quickstart markdown](${absoluteUrl("/docs/getting-started/quickstart.md")}): Human setup walkthrough
|
|
- [Agent CLI markdown](${absoluteUrl("/docs/cli-reference/ktx-agent.md")}): Machine-readable agent commands
|
|
|
|
## CLI Reference
|
|
|
|
${link("/docs/cli-reference/ktx-setup", "ktx setup", "Interactive project setup")}
|
|
${link("/docs/cli-reference/ktx-agent", "ktx agent", "Machine-readable commands for coding agents")}
|
|
${link("/docs/cli-reference/ktx-sl", "ktx sl", "Semantic-layer commands")}
|
|
${link("/docs/cli-reference/ktx-wiki", "ktx wiki", "Knowledge page commands")}
|
|
${link("/docs/cli-reference/ktx-connection", "ktx connection", "Connection management commands")}
|
|
|
|
## Integrations
|
|
|
|
${link("/docs/integrations/primary-sources", "Primary Sources", "Connect KTX to databases and warehouses")}
|
|
${link("/docs/integrations/context-sources", "Context Sources", "Ingest dbt, LookML, Metabase, Looker, MetricFlow, and Notion")}
|
|
|
|
## All Documentation
|
|
|
|
${buildPageIndex(pages)}
|
|
`;
|
|
}
|
|
|
|
export async function buildLlmsFullTxt() {
|
|
const rendered = await Promise.all(getLlmDocsPages().map(getPageMarkdown));
|
|
return [`# KTX Full Documentation`, `Source: ${siteOrigin}`, ...rendered].join(
|
|
"\n\n---\n\n",
|
|
);
|
|
}
|
|
|
|
function toLlmDocsPage(page: ReturnType<typeof source.getPages>[number]) {
|
|
return {
|
|
title: page.data.title,
|
|
description: page.data.description,
|
|
url: page.url,
|
|
markdownUrl: `${page.url}.md`,
|
|
slug: page.slugs,
|
|
getMarkdown: async () => normalizeMarkdown(page.data.content),
|
|
} satisfies LlmDocsPage;
|
|
}
|
|
|
|
function normalizeMarkdown(markdown: string) {
|
|
return markdown
|
|
.trim()
|
|
.replace(/^---\n[\s\S]*?\n---\n?/, "")
|
|
.trim()
|
|
.replace(/\n{3,}/g, "\n\n");
|
|
}
|
|
|
|
function buildPageIndex(pages: LlmDocsPage[]) {
|
|
const grouped = new Map<string, LlmDocsPage[]>();
|
|
|
|
for (const page of pages) {
|
|
const category = page.slug[0] ?? "general";
|
|
grouped.set(category, [...(grouped.get(category) ?? []), page]);
|
|
}
|
|
|
|
return [...grouped.entries()]
|
|
.map(([category, categoryPages]) => {
|
|
const links = categoryPages
|
|
.map((page) => {
|
|
const description = page.description ? `: ${page.description}` : "";
|
|
return `- [${page.title}](${absoluteUrl(page.markdownUrl)})${description}`;
|
|
})
|
|
.join("\n");
|
|
|
|
return `### ${formatCategoryName(category)}
|
|
|
|
${links}`;
|
|
})
|
|
.join("\n\n");
|
|
}
|
|
|
|
function absoluteUrl(path: string) {
|
|
return `${siteOrigin}${path}`;
|
|
}
|
|
|
|
function formatCategoryName(category: string) {
|
|
const labels: Record<string, string> = {
|
|
"ai-resources": "AI Resources",
|
|
"cli-reference": "CLI Reference",
|
|
};
|
|
|
|
if (labels[category]) {
|
|
return labels[category];
|
|
}
|
|
|
|
return category
|
|
.split("-")
|
|
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
|
|
.join(" ");
|
|
}
|