James Read's Code, Containers & Cloud blog

I’ve spent a fair bit of time on OliveTin documentation over the years — migrating to Antora, chasing broken links, adding search, and generally trying to make it usable for humans. That still matters. But recently I’ve been thinking about a second audience: LLMs and AI agents.

When someone (or something) asks “how do I configure OliveTin webhooks?” or “what’s the difference between shell and exec actions?”, the answer is probably already in the docs. The problem is getting there. HTML documentation sites are great in a browser — navigation, search, tabs, admonitions — but they’re awkward for an AI agent that wants a clean, text-first view of your content without scraping dozens of pages.

This evening finally marks the completion of the migration of https://docs.olivetin.app to a new build system, called Antora.

OliveTin’s documentation consists currently of 126 AsciiDoc files, 50 images, and many example config files, code examples, and similar. I would not say it is a very large documentation site, like OpenShift or any of the Red Hat documentation that I spend a lot of time reading (also written in AsciiDoc), but it’s a decent size that has been built up over the last 3 years.