docwalk / Documentation
docwalk, in detail
UI tutorials written by an agent, and replayed in CI so they never go stale
Project brief
docwalk lets a coding agent write step-by-step tutorials for a desktop or web app on its own. It reads the code, drives the running app, takes screenshots with framewatch, marks them up, and saves the result as a portable tutorial package.
The same package replays as a test in CI. If a button moves or a label changes, the tour fails and tells you which step broke, so your docs get fixed at the same time as the UI. Native tours work on macOS and web tours work anywhere. Windows and Linux support is written but not yet verified.
What’s included
• Records a tour by driving the real app, then replays it headless in CI with JUnit output
• Four fallback ways to find each element, with weakened matches flagged in the pull request
• Exports to Markdown, a standalone HTML viewer, Driver.js, Shepherd and MkDocs
• An MCP server with a built-in skill, so any agent can write tours
Current status
This is a prototype. This page describes where it’s headed now. It doesn’t promise general availability.
Questions and support
For questions about docwalk, contact DWMM Holdings with the project name and a short description of what you need. Please don’t send credentials or other sensitive information by email.