Skip to content

feat: Generate llms.txt for AI agents#869

Merged
lfrancke merged 1 commit into
mainfrom
feat/llms-txt
Jul 10, 2026
Merged

feat: Generate llms.txt for AI agents#869
lfrancke merged 1 commit into
mainfrom
feat/llms-txt

Conversation

@lfrancke

@lfrancke lfrancke commented Jul 7, 2026

Copy link
Copy Markdown
Member

Description

Adds an Antora extension that emits /llms.txt at build time.
It gives AI agents a machine-readable entry point to the docs:

  • indexes every page of the version that stable points to (the latest release; nightly in dev builds), grouped by module, with page descriptions from the :description: attribute
  • each entry links the published page and its AsciiDoc source on GitHub, so an agent (or human) can go from any docs URL straight to the file to change
  • cross-links the Stackable Hub's llms.txt for release/component/CRD data
  • Only the stable version is indexed on purpose - agents should not land on the old docs

This is not perfect yet and we can do more later (e.g. a ".md" file next to each normal docs page so agents don't have to read all that HTML stuff" or a llms-full.txt which we might be able to use in the OpenSearch RAG demo) but that's separate.

A new Antora extension emits /llms.txt (https://llmstxt.org/) at build
time. It indexes every page of the version that 'stable' points to,
with the page description and a link to the AsciiDoc source on GitHub,
and cross-links the machine-readable release/CRD data on the Stackable
Hub. This gives AI agents a way to discover and navigate the docs
without scraping HTML, and to locate the source file behind any page.
@netlify

netlify Bot commented Jul 7, 2026

Copy link
Copy Markdown

Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit 6cc48d7
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6a4d80bf88d92600088e7d1d
😎 Deploy Preview https://deploy-preview-869--stackable-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Jul 7, 2026
@dervoeti dervoeti moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Jul 10, 2026
@dervoeti dervoeti self-requested a review July 10, 2026 09:35

@dervoeti dervoeti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: some titles in llm.txt contain HTML entities, like Configuration & Environment Overrides.
Just noticed it, should not be a problem for LLMs.

@lfrancke lfrancke added this pull request to the merge queue Jul 10, 2026
Merged via the queue into main with commit 4cfc9c7 Jul 10, 2026
7 checks passed
@lfrancke lfrancke deleted the feat/llms-txt branch July 10, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: In Review

Development

Successfully merging this pull request may close these issues.

2 participants