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...

Faridoon: Save & Publish Your Favourite Chat Quotes

So many interactions with friends, family and coworkers now happen via our chat apps, and so many of the best bits of these chats just scroll by and are forgotten. Faridoon is a simple app that lets you save and publish your favourite chat quotes for you to save, for your community, or for the world to see.

I was inspired to write Faridoon a long time ago, when I was chatting with friends mostly on Mumble chat. We really liked the awesome simple interface of bash.org (now long since gone), but wanted to save our own quotes.


Continue reading...

About James Read

Picture of James Read James is a "full stack" Open Source enthusiast, who enjoys creating no-nonsense open source software.

Dad, hobbyist developer, open-source enthusiast and Red Hatter.