Add daily docs change agent playbook and README - #5262
Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Open
Conversation
Documents the scheduled agent that opens automated docs PRs: the full playbook it follows on every run, plus a README covering how it runs, which repos it monitors, and where its state files live. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
Contributor
|
Two things:
|
10zingpd
approved these changes
Aug 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this adds
A new top-level
docs-agent/directory (outside Hugo'sdocs/content tree, so it does not affect the built site) documenting the scheduled agent that opens automated docs PRs against this repo:docs-agent/README.md: what the agent is, how and when it runs, which repos it monitors, and where its mutable state livesdocs-agent/playbook-daily-code-changes.md: the complete procedure the agent follows on every run (diff collection, 14 docs-impact change cases, search rules, PR grouping, Copilot review handling, state updates)What this intentionally leaves out
The agent's state files (
backlog.yaml,run-history.yaml,maintenance.md, and others) stay in their separate private repo because the agent rewrites them on every run, and some summarize commits from private repos, which should not be published here.The playbook copy carries a
vale offdirective: it is internal tooling documentation, not user-facing docs content, so Viam prose style rules are not applied to it. No credentials appear in either file; the agent's GitHub token lives only in its scheduled-run environment.Checks run
npx prettier@3.2.5 --write docs-agent/vale docs-agent/(0 errors)make build-prod(passes; page count unchanged)🤖 Generated with Claude Code