Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Changelog entry

Agent discovery, verified Markdown, and incremental sync

Find the right page with less context, verify its contents, and fetch only what changed.

Read as Markdown

Agents can now find pages through smaller indexes, check which build they are reading, and compare saved page inventories before fetching updates.

  • Smaller discovery files. llms.min.txt lists page IDs, titles, summaries, and Markdown links. search-index.min.json adds headings without article text. Markdown 404 responses point to these compact files.
  • Incremental sync. Clients can check build-info.json for a new build, then compare documents.sync.json with their saved snapshot to find added, changed, and removed pages. They can fetch only the pages that need updating instead of downloading the full manifest and every page again. shoalrun docs changes CURRENT-SNAPSHOT --since PREVIOUS-SNAPSHOT performs the comparison locally.
  • Verifiable responses. Markdown responses include a fingerprint that lets clients check whether a page changed without downloading it again, plus a link to its manifest record. Focused API contracts now use their actual content digest in the URL, allowing a one-year immutable cache policy.
  • Clearer examples. Fictional pages carry a machine-readable demo flag. The refreshed agent-friendly guide puts working tabs, a disclosure, and reader choices beside the Markdown an agent receives.

Try the example and see what an agent reads. The output reference covers the files, digests, and sync workflow.