docs: remove section overview pages (#130)

This commit is contained in:
Luca Martial 2026-05-18 09:49:43 -04:00 committed by GitHub
parent e64da5a85d
commit d60d83e595
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 37 additions and 148 deletions

View file

@ -1,13 +1,29 @@
---
title: "Overview"
description: "Command map and shared options for the KTX CLI."
title: "ktx"
description: "Root command map, global options, and project resolution for the KTX CLI."
---
The `ktx` CLI sets up local projects, builds agent-ready context, checks
connections, queries semantic-layer sources, searches wiki pages, runs the MCP
server, and manages the bundled Python runtime.
## Command Map
## Command signature
```bash
ktx [global-options] <command>
```
When you run bare `ktx` in an interactive terminal outside any KTX project, the
CLI starts the same guided setup flow as `ktx setup`. Inside an existing
project, use command-specific help:
```bash
ktx --help
ktx setup --help
ktx ingest --help
```
## Command map
```text
ktx
@ -45,7 +61,7 @@ ktx
The public context-build entrypoint is `ktx ingest [connectionId]` or
`ktx ingest --all`.
## Global Options
## Global options
| Flag | Description |
|------|-------------|
@ -54,14 +70,14 @@ The public context-build entrypoint is `ktx ingest [connectionId]` or
| `-v`, `--version` | Show the CLI package name and version. |
| `-h`, `--help` | Show help for the current command. |
## Project Resolution
## Project resolution
Most commands are project-aware. Pass `--project-dir <path>` when scripting or
when you are outside the project directory. If you omit it, KTX checks
`KTX_PROJECT_DIR`, then walks upward for the nearest `ktx.yaml`, then falls back
to the current directory.
## Common Workflows
## Common workflows
```bash
# Start or resume setup

View file

@ -2,7 +2,7 @@
"title": "CLI Reference",
"defaultOpen": true,
"pages": [
"index",
"ktx",
"ktx-setup",
"ktx-connection",
"ktx-ingest",