Writing good docs isn't just for humans
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.
Continue reading...
James is a "full stack" Open Source enthusiast, who enjoys creating no-nonsense open source software.