Skip to content
LumenFlow

Agent-Readable Public Docs

LumenFlow’s documentation build emits three public Markdown files for agents and other text-based clients:

  • llms.txt is the short documentation index.
  • llms-full.txt contains the complete rendered public documentation.
  • llms-small.txt is the compact rendition for smaller context windows.

Use the index to discover relevant topics, then retrieve the smallest feed that contains the material you need. The compact feed omits individual CLI command detail pages to reduce size. The full feed includes those pages even though they are not listed individually in the site sidebar. It retains rendered command examples and warning or caution content.

What the feeds contain

Section titled “What the feeds contain”

The feeds are generated from the public Starlight docs collection. The generator includes entries in the default locale that are not drafts; sidebar visibility is not an export filter. Repository-root operations notes and ADR source files are outside that collection and are not inputs to these feeds. Public pages may still mention repository paths or external links in ordinary explanatory text.

The configured exclusion for CLI detail pages affects only llms-small.txt. It does not remove those pages from the full feed. The full feed is intended to preserve the published reference material rather than produce a confidentiality-filtered copy.

Limits

Section titled “Limits”

These files are local static-site build outputs. Their existence does not prove that a deployment is reachable or that a LumenFlow Cloud corpus has ingested or refreshed them. This documentation build has no automatic Cloud ingestion behavior.

The feeds preserve links from their source pages. When following a relative link in a flattened feed, use its surrounding page heading and the public documentation site to identify the original page context. A link to a browsable file in the private hellmai/lumenflow-dev repository is not a usable public-document link; see the public CLI reference or the relevant published guide instead.

The feed generator is the maintained starlight-llms-txt integration. Its version is pinned in the docs package and is verified by a local build-output smoke check.