mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
42b688e934
* docs: align docs with current KTX behavior * fix: generate valid agent sl query command * docs: clarify KTX product mechanics * fix: use <ol> for runtime pipeline steps in product mechanics The PipelineStep component renders <li> elements, but the RuntimeDiagram wrapper was a plain <div> instead of a list element. This produced invalid HTML and accessibility warnings. IngestionDiagram already used <ol>. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add docs favicon * docs: add semantic layer internals concept * docs: refine documentation source label * docs: clarify company documentation examples --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
75 lines
2.9 KiB
Text
75 lines
2.9 KiB
Text
---
|
|
title: Introduction
|
|
description: How KTX gives analytics agents trusted context for warehouse work.
|
|
---
|
|
|
|
import { ProductMechanics } from "@/components/product-mechanics";
|
|
|
|
<div className="not-prose mb-10">
|
|
<div>
|
|
<h1
|
|
className="max-w-full text-3xl font-extrabold tracking-tight break-words sm:text-4xl lg:text-5xl"
|
|
style={{
|
|
fontFamily: 'var(--font-display)',
|
|
background: 'linear-gradient(180deg, var(--color-fd-foreground) 0%, color-mix(in oklch, var(--color-fd-foreground) 75%, var(--color-fd-primary)) 100%)',
|
|
WebkitBackgroundClip: 'text',
|
|
backgroundClip: 'text',
|
|
color: 'transparent',
|
|
WebkitTextFillColor: 'transparent',
|
|
lineHeight: '1.1',
|
|
letterSpacing: '0',
|
|
}}
|
|
>
|
|
Make analytics context usable by agents
|
|
</h1>
|
|
<p className="mt-4 max-w-2xl text-lg text-fd-muted-foreground" style={{ lineHeight: '1.7' }}>
|
|
{'KTX turns warehouse metadata, semantic definitions, and business knowledge into reviewable project files that agents can use while planning, querying, and updating analytics work.'}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<ProductMechanics />
|
|
|
|
## What agents can do with KTX
|
|
|
|
KTX is built for analytics engineers and data teams who want data agents to
|
|
work on real analytics systems, not just generate one-off SQL.
|
|
|
|
Use it when agents need to:
|
|
|
|
- **Generate SQL** from approved measures, dimensions, joins, and filters
|
|
- **Explain provenance** with wiki context and warehouse evidence
|
|
- **Repair context** through reviewable YAML and Markdown diffs
|
|
- **Work alongside** dbt, LookML, MetricFlow, Looker, Metabase, and warehouses
|
|
|
|
KTX works with SQLite, PostgreSQL, Snowflake, BigQuery, ClickHouse, MySQL, and
|
|
SQL Server.
|
|
|
|
## Read next
|
|
|
|
<Cards>
|
|
<Card title="Quickstart" href="/docs/getting-started/quickstart">
|
|
Set up KTX and build your first context in under 10 minutes.
|
|
</Card>
|
|
<Card title="Guides" href="/docs/guides/building-context">
|
|
Hands-on workflows for scanning, ingesting, writing, and serving.
|
|
</Card>
|
|
<Card title="Writing Context" href="/docs/guides/writing-context">
|
|
Edit semantic-layer YAML and wiki Markdown safely.
|
|
</Card>
|
|
<Card title="CLI Reference" href="/docs/cli-reference/ktx-setup">
|
|
Complete flag and subcommand reference for every KTX command.
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Agent usage notes
|
|
|
|
| Agent task | Read next |
|
|
|------------|-----------|
|
|
| Discover machine-readable docs | [AI Resources](/docs/ai-resources) |
|
|
| Learn how a coding assistant should approach KTX | [Agent Quickstart](/docs/ai-resources/agent-quickstart) |
|
|
| Set up a new KTX project | [Quickstart](/docs/getting-started/quickstart) |
|
|
| Explain what problem KTX solves | [The Context Layer](/docs/concepts/the-context-layer) |
|
|
| Scan a database and ingest metadata | [Building Context](/docs/guides/building-context) |
|
|
| Edit semantic sources or wiki pages | [Writing Context](/docs/guides/writing-context) |
|
|
| Look up exact command flags | [CLI Reference](/docs/cli-reference/ktx-setup) |
|