Skip to content

Add the weekly docs version updater - #2

Merged
MarcoDotIO merged 1 commit into
mainfrom
ci/docs-version-updater
Nov 6, 2026
Merged

MarcoDotIO merged 1 commit into
mainfrom
ci/docs-version-updater

Conversation

@MarcoDotIO

Copy link
Copy Markdown
Member

Adds the weekly software-version check for the lab's docs repositories: a reusable workflow, .github/workflows/docs-version-updater.yml, and the checker it runs, tools/docs-version-updater/updater.py.

How it works. Each page gets its own conversation with Claude (claude-opus-5-5, effort medium, adaptive thinking, server-side refusal fallback). The conversation carries the repository's AGENTS.md and the page, and Claude has web search, web fetch, read access to the repository's other Markdown files and an edit_page tool. The instructions:

  • correct facts that primary sources show are out of date;
  • remove, or mark as deprecated, versions and features that reached end of life;
  • describe newer releases' features where they change how readers use a tool, as plain facts with at most a release date and never as "new";
  • leave lab facts, placeholders and correct wording alone.

The code refuses any edit that matches more than one passage, drops a [placeholder] or has no https:// source. After the run, any page that fails markdownlint or the lab brand check goes back to its committed version. Whatever is left becomes one PR on automation/version-updates, listing every change with its sources and an estimated API cost.

Tested locally on getting-started-atr-lab/tech-stack/gazebo.md: 56 seconds and $0.34. It made one correct edit, ROS 2 Rolling's pairing with Gazebo Rotary, which I checked against gazebosim.org. Ruff (the lab's ruff.toml) passes, markdownlint shows 0 issues and the brand check shows 0 errors.

Callers: ATR-Lab/getting-started-atr-lab, ATR-Lab/all-things-ros2 and ATR-Lab/dev-guidelines, in their ci/version-check PRs. Merge this one first, because they use @main.

🤖 Generated with Claude Code

A reusable workflow and checker that has Claude (claude-opus-5-5, effort medium, web search and fetch) check the software facts on docs pages against primary sources, edit them with cited sources, drop any page that fails markdownlint or the brand check, and open one pull request.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MarcoDotIO
MarcoDotIO merged commit da59be1 into main Nov 6, 2026
2 checks passed
@MarcoDotIO
MarcoDotIO deleted the ci/docs-version-updater branch November 6, 2026 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant