Skip to content

Add llms.txt for LLM-friendly site overview - #3579

Open
cuihtlauac wants to merge 4 commits into
mainfrom
llms-txt
Open

Add llms.txt for LLM-friendly site overview#3579
cuihtlauac wants to merge 4 commits into
mainfrom
llms-txt

Conversation

@cuihtlauac

Copy link
Copy Markdown
Collaborator

Summary

  • Add asset/llms.txt following the llms.txt convention, a curated markdown index of ocaml.org's most valuable content for LLMs
  • Covers tutorials, manual, API, cookbook, exercises, books, papers, platform tools, packages, releases, community, and success stories (~90 annotated links)
  • Served via the existing static asset loader (same as robots.txt), marked as not_cached for immediate propagation

Context

The llms.txt spec provides a standardised way to help LLMs understand a website's content. While robots.txt controls what crawlers can access, llms.txt is a positive signal that curates the most useful pages. This helps LLMs that do have access produce better, more accurate answers about OCaml.

Test plan

  • make build succeeds
  • curl localhost:8080/llms.txt returns the content with Cache-Control: no-store, max-age=0
  • Content is valid markdown and follows the llms.txt spec (H1, blockquote, H2 sections with link lists)

🤖 Generated with Claude Code

cuihtlauac and others added 4 commits June 9, 2026 15:13
Provide a curated index of ocaml.org content following the llms.txt
convention (https://llmstxt.org/). This helps LLMs produce better
answers about OCaml by pointing them to tutorials, manual, cookbook,
exercises, and other high-value pages.

The file is served as a static asset (like robots.txt) and marked
as not_cached so updates propagate immediately.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Success-story page slugs are derived from slugify(title), not the
filename, so the original /success-stories/<name> links all 404ed.
Point each link at the real title-derived slug and lead each entry with
its most quotable stat from data/success_stories/.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…nges

llms.txt hardcodes ocaml.org URLs whose slugs are derived from content
titles/ids, not filenames, and nothing in CI validates them. Document
the footgun in the 'Working with data/' section.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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