Skip to content
GitHub Agentic Workflows

Meet the Workflows: Continuous Documentation

Peli de Halleux

Step right up, step right up, and enter the documentation chamber of Peli’s Agent Factory! Pure imagination meets technical accuracy in this most delightful corner of our establishment!

In our previous posts, we explored autonomous cleanup agents - workflows that continuously improve code quality by simplifying complexity, refactoring structure, polishing style, and maintaining overall repository health. These agents never take a day off, quietly working to make our codebase better.

Now let’s address one of software development’s eternal challenges: keeping documentation accurate and up-to-date. Code evolves rapidly; docs… not so much. Terminology drifts, API examples become outdated, slide decks grow stale, and blog posts reference deprecated features. The question isn’t “can AI agents write good documentation?” but rather “can they maintain it as code changes?” Documentation and content workflows challenge conventional wisdom about AI-generated technical content. Spoiler: the answer involves human review, but it’s way better than the alternative (no docs at all).

These agents maintain high-quality documentation and content:

Documentation is where we challenged conventional wisdom. Can AI agents write good documentation?

The Technical Doc Writer generates API docs from code, but more importantly, it maintains them - updating docs when code changes. The Glossary Maintainer caught terminology drift (“we’re using three different terms for the same concept”).

The Slide Deck Maintainer keeps our presentation materials current without manual updates.

The Multi-device Docs Tester uses Playwright to verify our documentation site works across phones, tablets, and desktops - testing responsive layouts, accessibility, and interactive elements. It catches visual regressions and layout issues that only appear on specific screen sizes.

The Blog Auditor ensures our blog posts stay accurate as the codebase evolves - it flags outdated code examples and broken links.

AI-generated docs need human/agent review, but they’re dramatically better than no docs (which is often the alternative). Validation can be automated to a large extent, freeing writers to focus on content shaping, topic, clarity, tone, and accuracy.

In this collection of agents, we took a heterogeneous approach - some workflows generate content, others maintain it, and still others validate it. Other approaches are possible - all tasks can be rolled into a single agent. We found that it’s easier to explore the space by using multiple agents, to separate concerns, and that encouraged us to use agents for other communication outputs such as blogs and slides.

You can add these workflows to your own repository and remix them. Get going with our Quick Start, then run one of the following:

Daily Documentation Updater:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/daily-doc-updater.md

Glossary Maintainer:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/glossary-maintainer.md

Documentation Unbloat:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/unbloat-docs.md

Documentation Noob Tester:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/docs-noob-tester.md

Slide Deck Maintainer:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/slide-deck-maintainer.md

Multi-device Docs Tester:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/daily-multi-device-docs-tester.md

Blog Auditor:

Terminal window
gh aw add https://github.com/github/gh-aw/blob/v0.37.7/.github/workflows/blog-auditor.md

Then edit and remix the workflow specifications to meet your needs, recompile using gh aw compile, and push to your repository. See our Quick Start for further installation and setup instructions.

Beyond writing code and docs, we need to manage the flow of issues and pull requests. How do we keep collaboration smooth and efficient?

Continue reading: Issue & PR Management Workflows →


This is part 6 of a 19-part series exploring the workflows in Peli’s Agent Factory.