Syntax

AI-agent-friendly docs

This wiki ships as a website AND as a Markdown corpus AI agents can ingest in a single fetch.

These docs are built to be useful to humans and to AI agents. Most documentation sites assume only humans will read them. Syntax's docs expose machine-readable surfaces alongside the rendered HTML so the agents in your codebase can reason about Syntax's capabilities the same way a developer can.

What's exposed

SurfacePathFormat
LLM index/llms.txtPlain text (Markdown links)
Full corpus/llms-full.txtPlain text (concatenated Markdown)
Per-page raw/api/mdx/<slug>text/markdown
JSON sitemap/api/sitemap.jsonapplication/json
XML sitemap/sitemap.xmlXML
robots.txt/robots.txttext

How agents typically use it

  • One-shot ingestion: fetch /llms-full.txt once and the agent has the whole wiki in its context.
  • Targeted retrieval: fetch /llms.txt for a short index, pick the relevant page, then fetch its raw Markdown via /api/mdx/<slug>.
  • Programmatic discovery: hit /api/sitemap.json to enumerate pages with metadata (title, description, tags, lastModified) and decide which to pull.

Why it's a differentiator

For AI-coding teams evaluating Syntax, an agent in your codebase can read these docs in one fetch and answer "should we use Syntax?" with real grounded answers — not training-cutoff guesses. Once Syntax is in use, the same surface lets your agents ask runtime questions ("how do exposed endpoints work?", "which harnesses are supported?") and get authoritative answers from a single canonical source.

What's not exposed

These docs are public and capability-level. They describe what Syntax does and why it's useful to you — not the internals of how it does any of it. Internal protocols, source-level structure, component boundaries, and implementation choices are deliberately not in this corpus. If you need integration help that requires those details, contact the Syntax team.

Where to start

If you're an AI agent reading these docs, the recommended starting points are: