Skip to content

Introducing docs.obarun.org — automated, centralized documentation

Dear Obarun Community,

Documentation for every Obarun program now lives under a single dedicated domain: docs.obarun.org. More importantly, it now updates itself.

Why this change

Until now, every documentation update required a manual change on the website side: each new software release meant editing the site, regenerating pages, and republishing — for every tag, on every project. That overhead delayed updates and made the published documentation chronically out of sync with the actual releases.

The new setup removes that step entirely. When a new tag is created on a software's repository, its documentation is built and published automatically to docs.obarun.org. No human intervention, no website edit, no manual deploy. The documentation you read on docs.obarun.org reflects the tags as they happen.

How it works

The list of available software is still accessible from web.obarun.org/software. Selecting the documentation of a program now opens its dedicated section on docs.obarun.org, versioned per release. For example, the documentation of 66 for a given version is available at:

https://docs.obarun.org/66/<version>/

Every published version stays online at its own URL, so older releases remain referenceable.

Always reach the latest version

Each software exposes a latest shortcut that always points to the most recent published version of its documentation. No need to track version numbers — the link follows the tags automatically:

The same pattern applies to every Obarun program: docs.obarun.org/<software>/latest/.

Under the hood

All documentation is rendered with mkdocs-material, sharing the same theme, search, and navigation across projects. The publication pipeline is wired into each software's CI: a tag push triggers the build and deploy, and the new version (plus the latest/ shortcut) is live within minutes.

We hope this new layout makes the documentation easier to find, to trust, and to link to.

Thank you for being part of the Obarun journey!

Eric Vidal eric@obarun.org