Skip to content

docs: add llm.txt with repository context - #198

Open
miqui wants to merge 4 commits into
OAI:mainfrom
miqui:add-llm-txt
Open

miqui wants to merge 4 commits into
OAI:mainfrom
miqui:add-llm-txt

Conversation

@miqui

@miqui miqui commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Add an llm.txt file at the repository root with a short description of the project to support LLM-oriented tooling and discovery.

miqui and others added 2 commits April 6, 2026 18:48
Add an llm.txt file at the repository root with a short description
of the project to support LLM-oriented tooling and discovery.

Co-Authored-By: Oz <oz-agent@warp.dev>
@miqui
miqui requested review from baywet, lornajane and ralfhandl April 6, 2026 22:50
@miqui

miqui commented Apr 6, 2026

Copy link
Copy Markdown
Contributor Author

reference: https://llmstxt.org/

@lornajane

Copy link
Copy Markdown
Contributor

I'd like us to progress with our AI policy statements before implementing any tooling support.

@miqui

miqui commented Apr 7, 2026

Copy link
Copy Markdown
Contributor Author

@lornajane > I'd like us to progress with our AI policy statements before implementing any tooling support.

Ok, then this AI topic should be a high priority imho. Where is this work being done? Is there a thread? Thanks.

@lornajane

Copy link
Copy Markdown
Contributor

The discussion is on the main spec repo: OAI/OpenAPI-Specification#5209

@lornajane

Copy link
Copy Markdown
Contributor

Jumping back in here as we're making progress on the overall AI policy topics.

How does this content stay up to date? Would it make more sense to have a generator script that builds this page at the same time as the website?

@miqui

miqui commented Jun 7, 2026

Copy link
Copy Markdown
Contributor Author

hi @lornajane - good point. Other repos (I assume maintain it manually - I don't think this file changes often). However, I am looking into your suggestion.

Rename llm.txt to llms.txt (llmstxt.org convention) and replace the
hand-maintained page list with a Liquid template that builds it from
page front matter, so it cannot drift from the site.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@miqui

miqui commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

@lornajane Updated: llm.txt is now llms.txt (llmstxt.org convention) and is generated at build time from page front matter via a Liquid template. No plugin needed, and it can't drift from the site. Verified with a Docker Jekyll build. Since the AI policy question is resolved, this should be ready for another look.

@miqui

miqui commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

@lornajane , @baywet , @ralfhandl

In practice:

  • If someone adds specification/foo.md with a title and a parent, it
    appears in llms.txt on the next build. Nobody touches llms.txt.
  • If someone renames or reorders a page, the file follows.
  • The intro paragraph and the "Related resources" links at the bottom are
    still static text in the template. Everything else is generated.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants