Skip to main content

Atryum Documentation

Content Engineering

Content Architecture
Feature Documentation
User Guides
Training & Onboarding
Python
Rust
HTML

Atryum is an open-source agentic orchestration tool developed by ValidMind. As ValidMind’s sole Senior Technical Writer, I was responsible for almost all of the documentation for Atryum.

Along with authoring approximately 95% of the content for Atryum,1 I also designed and implemented the static documentation website authoring flow.

Situation

The original ask was just to produce complete documentation for Atryum within one business day, hosted on a static website.

I wanted to go beyond just content by making the authoring process easier and more efficient, as the existing framework required writers to edit a static HTML file directly just to update content.

Solution

Instead of editing giant messes of static HTML files directly, writers now create or edit .md files under a md-drafts directory, then call a just docs command that builds .html files from the Markdown using a Python script, automatically populating links to any new pages in the existing navigation:2

2  validmind/atryum/website/scripts: md_to_html.py

docs:
    python3 website/scripts/md_to_html.py

Comparisons

Some comparisons of the content I managed to produce for the Atryum within a very short timeline:

Landing Page

The old landing page, with spilt install scripts:

Previous Atryum Landing Page

My new landing page, with a combined smart install script:

New Atryum Landing Page

Quickstart

The old Docs (Quickstart) page:

Previous Atryum Quickstart

You’ll also note that this was the only existing documentation on the website before my involvement.

My new cleaned up Quickstart page:

New Atryum Quickstart

Along with this Quickstart page, I also produced the rest of the guides linked in the top navigation.

You can browse the rest of the guides I authored under Atryum Samples.

Atryum User Guidance