mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
64 lines
3.2 KiB
Text
64 lines
3.2 KiB
Text
---
|
|
title: AI Resources
|
|
description: Machine-readable docs, retrieval paths, and prompt recipes for coding assistants using KTX documentation.
|
|
---
|
|
|
|
Use this section when a coding assistant, IDE agent, or automation system needs
|
|
to read, cite, or update KTX documentation. These resources are optimized for
|
|
retrieval: agents can fetch small Markdown pages, use the full corpus only when
|
|
needed, and copy prompts that point them at current setup and CLI behavior.
|
|
|
|
> **Documentation index**
|
|
>
|
|
> Start with [`/llms.txt`](/llms.txt) to discover the available docs. Use
|
|
> [`/llms-full.txt`](/llms-full.txt) when the assistant needs the complete docs
|
|
> corpus in one Markdown response.
|
|
|
|
## What agents can do
|
|
|
|
| Need | Recommended path |
|
|
|------|------------------|
|
|
| Find the right setup or CLI page | Fetch [`/llms.txt`](/llms.txt), then read the smallest matching `.md` page |
|
|
| Answer a setup question | Read [Agent Quickstart](/docs/ai-resources/agent-quickstart), then [Quickstart](/docs/getting-started/quickstart) or [ktx setup](/docs/cli-reference/ktx-setup) |
|
|
| Quote a command or flag | Read the matching [CLI Reference](/docs/cli-reference) page as Markdown |
|
|
| Update docs in this repo | Use [Agent Instructions](/docs/ai-resources/agent-instructions) and verify generated Markdown routes after editing |
|
|
| Reuse a prompt | Copy from [Prompt Recipes](/docs/ai-resources/prompt-recipes) |
|
|
|
|
## Section map
|
|
|
|
| Goal | Use this page |
|
|
|------|---------------|
|
|
| Give an assistant a task-first route through the docs | [Agent Quickstart](/docs/ai-resources/agent-quickstart) |
|
|
| Fetch docs as Markdown instead of rendered HTML | [Markdown Access](/docs/ai-resources/markdown-access) |
|
|
| Add lightweight KTX docs guidance to a system prompt | [Agent Instructions](/docs/ai-resources/agent-instructions) |
|
|
| Copy prompts for setup, command lookup, and docs editing | [Prompt Recipes](/docs/ai-resources/prompt-recipes) |
|
|
|
|
## Available resources
|
|
|
|
| Resource | What it gives agents |
|
|
|----------|----------------------|
|
|
| [`/llms.txt`](/llms.txt) | Curated index of high-value KTX docs and Markdown endpoints |
|
|
| [`/llms-full.txt`](/llms-full.txt) | Complete docs corpus in one plain-text Markdown response |
|
|
| `/docs/<path>.md` | Per-page Markdown for any docs page |
|
|
| Page-level actions | Copy Markdown, view Markdown, or copy MDX from rendered docs pages |
|
|
| Prompt recipes | Reusable prompts for docs lookup, setup help, command discovery, and docs editing |
|
|
|
|
## Agent usage notes
|
|
|
|
When an assistant is unsure where to begin, use this retrieval order:
|
|
|
|
1. Read [`/llms.txt`](/llms.txt).
|
|
2. Fetch one or two specific Markdown pages for the task.
|
|
3. Use [Agent Quickstart](/docs/ai-resources/agent-quickstart) to choose the
|
|
next command, guide, or CLI reference page.
|
|
4. Use [`/llms-full.txt`](/llms-full.txt) only when the answer requires broad
|
|
context across setup, integrations, concepts, and CLI reference.
|
|
5. Use page-level copy actions when the user wants exact generated Markdown or
|
|
source MDX.
|
|
|
|
## Boundaries
|
|
|
|
AI Resources explain how agents consume the docs. To install KTX into an
|
|
agent client, use [Agent Clients](/docs/integrations/agent-clients). To set up a
|
|
project, use [Quickstart](/docs/getting-started/quickstart) or
|
|
[`ktx setup`](/docs/cli-reference/ktx-setup).
|