Skip to content

ci: add Claude Code Review workflow for docs PRs#2

Open
JOY (JOY) wants to merge 1 commit into
mainfrom
ci/claude-code-review
Open

ci: add Claude Code Review workflow for docs PRs#2
JOY (JOY) wants to merge 1 commit into
mainfrom
ci/claude-code-review

Conversation

@JOY
Copy link
Copy Markdown
Contributor

Summary

The DOS.AI code repo auto-reviews every PR (claude-code-review), but this docs repo had no PR reviewer - docs PRs (e.g. the partner-API update #1) ship unreviewed. This mirrors that workflow, retuned for a Markdown docs repo.

What it reviews

  • Factual accuracy: API base URLs, endpoint paths, auth schemes, request/response shapes, code samples vs the real product (flag stale/invented).
  • Broken links: internal page links + external URLs.
  • Consistency: terminology/endpoint naming/auth examples agree across pages.
  • House style: ASCII hyphens only - flag em-dash (—) / en-dash (–).
  • Completeness: new endpoints/params documented; deprecated ones marked.

Details

  • anthropics/claude-code-action@v1, org secret CLAUDE_CODE_OAUTH_TOKEN (same as the code repo).
  • Read-only perms + gh pr comment allowed-tools; review-only (does not edit docs).
  • Triggers on pull_request opened/synchronize. No build step.

Note

This would have caught the stale app.dosafe.io/api base URL + the non-existent /detect-audio endpoint in PR #1 (which I fixed manually after fact-checking against the gateway source). Going forward, docs PRs get the same automated gate as code PRs.

Test plan

  • Merge, then open a trivial docs PR -> a "Claude Code Review" check runs and posts a review comment
  • Confirm the org secret CLAUDE_CODE_OAUTH_TOKEN is available to this repo (it's used by the code repo's workflow)

🤖 Generated with Claude Code

The DOS.AI code repo auto-reviews every PR via claude-code-review, but
this docs repo had no PR reviewer - docs PRs (e.g. the partner-API
update #1) shipped unreviewed. Mirrors that workflow, retuned for a
documentation repo:

- Reviews for factual accuracy (base URLs, endpoint paths, auth schemes,
  code samples vs the real product), broken links, cross-page
  consistency, house style (ASCII hyphens only - flag em/en-dashes), and
  completeness.
- Same org secret CLAUDE_CODE_OAUTH_TOKEN, same anthropics/claude-code-action@v1,
  same read-only permissions + gh-comment allowed-tools.

Runs on pull_request opened/synchronize. No build step (Markdown repo).
@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dos-ai-docs Ready Ready Preview, Comment May 23, 2026 6:53pm

@JOY
Copy link
Copy Markdown
Contributor Author

Author hand-off (for DOS.AI-Docs maintainers)

Authored by JOY's Claude Code session - handed to the team to review + merge (I won't self-merge). YAML validated locally.

One thing to confirm before/at merge: the workflow uses secrets.CLAUDE_CODE_OAUTH_TOKEN. It's the same org secret the DOS.AI code repo's reviewer uses, so it should be available org-wide - but if this repo isn't in the org-secret's repo allowlist, the action will fail auth on the first PR. Quick check: Settings -> Secrets and variables -> Actions, or just watch the first PR after merge.

Meta note: once this merges, it can't retro-review the currently-open docs PR #1 (workflows only run on PRs opened/synced after they exist on the base branch). I already fact-checked #1 manually against the gateway source.

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