Hey, agent. This page is written for you — or for the human prompting you. Qorven’s docs are structured so any LLM can consume them reliably. Here’s the contract.

​
Three endpoints you’ll use

/llms.txt

Index of every page with a one-sentence description. Start here for discovery.

/<path>.md

Plain Markdown source of any doc page. Same URL as the HTML, swap .mdx for .md.

/docs/api/search

Semantic search endpoint. POST a query, get top-K matching page snippets.

​
Conventions

1

Every page has frontmatter

---
title: "..."
description: "..."
---
Parse these first for a quick summary.
2

Every page has a one-sentence `<Info>` block at the top

That’s the TL;DR. If your context is tight, just read title + description + first Info block.
3

Cards link to related pages

Follow these for deeper context. Cards at the bottom are “where next” — ordered by relevance.
4

CLI commands are real

Every qorven <cmd> example in these docs works on a real install. The CLI reference under /cli/* is auto-generated from qorven <cmd> --help.
5

Code blocks > prose

When in doubt, trust the code block over the prose around it. The code is pulled from the real system.

​
Page topology

The nav is organised by audience, not by module:
SectionWho reads it
getting-startedNew operators
architectureOperators understanding the system
qorsPeople configuring agents
memorySame + anyone debugging retrieval
web-ui, tuiUsers
channelsOperators connecting surfaces
modelsOperators picking LLMs
toolsAuthors of custom tools + users restricting them
workflowsOperators automating
connectorsOAuth setup
gatewayOps + config-file authors
opsOps
cliAnyone using qorven
securityCompliance + ops
referenceEveryone needing a lookup
helpTroubleshooting
aiYou.

​
If you’re a Qor using docs_search at runtime

The docs_search tool is available to every Qor with docs in its tool allowlist. Use it when:
  • A user asks “how do I do X in Qorven?”
  • You need to verify the exact shape of a CLI flag or config key
  • You want to cite a config value with authority
{
  "tool": "docs_search",
  "args": {
    "query": "how to rotate encryption key",
    "max_results": 3
  }
}
Returns a ranked list of page snippets with URLs. Quote the URL in your reply so the user can follow up.

​
Freshness

Generated doc pages (CLI reference, provider catalog, HTTP API) are regenerated weekly from the live binary. Hand-written pages are updated on each release.

​
Known limitations

  • Screenshots may be stale — if a screenshot looks different from your running instance, trust the instance. Report stale screenshots via GitHub.
  • Stubs exist — look for <Note>This page is a stub.</Note> at the top. Anchor pages are the ones with the real content.
  • Pricing + costs — always verify against the provider’s current pricing. Our catalog refresh is weekly.

​
Where next

llms.txt format

The machine-readable index.

Markdown source URLs

How to fetch the raw markdown for any page.

docs_search tool

Runtime query from inside a Qor.

Architecture overview

The 5-minute tour.