Skip to content

ci: refine docs-sync for concise updates#2431

Merged
kronosapiens merged 2 commits intomainfrom
kronosapiens/refine-docs-sync
Feb 17, 2026
Merged

ci: refine docs-sync for concise updates#2431
kronosapiens merged 2 commits intomainfrom
kronosapiens/refine-docs-sync

Conversation

@kronosapiens
Copy link
Contributor

@kronosapiens kronosapiens commented Feb 17, 2026

Summary

docs-sync workflow:

  • Rewrite the Claude prompt to default to no changes and enforce a single canonical location rule — edits go on the one page that owns the topic, with cross-references allowed but no duplicated content
  • Pass the actual diff (not just filenames) so Claude sees what changed instead of guessing from full files
  • Tighten trigger patterns to packages/ SDK code only, dropping internal src/, package.json, README.md, CHANGELOG.md
  • Pin model to claude-sonnet-4-5 for cost and predictability

claude-code-review workflow:

  • Add allowed_tools: "Read,Glob,Grep" to prevent non-deterministic failures when Claude attempts Bash calls (e.g. gh pr list) during review

Motivation

The docs-sync workflow produces overly broad docs PRs — the same change gets referenced 3-5+ times across overview, getting-started, and detail pages.
The new prompt rules (DEFAULT TO NO CHANGES, SINGLE CANONICAL LOCATION, MINIMAL EDITS, ONE CODE EXAMPLE) should produce tighter, more focused updates.

The review workflow intermittently fails when Claude decides to use Bash, which isn't permitted in CI. Restricting to read-only tools eliminates this.

Test plan

  • Trigger docs-sync via workflow_dispatch on a recent commit that changed SDK code and verify the resulting docs PR is focused
  • Trigger on a commit that only touches internal code and verify no docs PR is created
  • Verify the code review workflow passes on this PR without Bash permission errors

🤖 Generated with Claude Code

- Rewrite Claude prompt to default to no changes, enforce single
  canonical location for edits, and minimize duplication
- Pass actual diff content (not just filenames) so Claude sees
  what changed
- Tighten file patterns to packages/ SDK code only, dropping
  internal src/, package.json, README, CHANGELOG
- Pin model to sonnet-4.5 for predictability and cost

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 17, 2026

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

Project Deployment Actions Updated (UTC)
controller-example-next Ready Ready Preview Feb 17, 2026 4:30pm
keychain Ready Ready Preview Feb 17, 2026 4:30pm
keychain-storybook Ready Ready Preview Feb 17, 2026 4:30pm

Request Review

Add allowed_tools to prevent Claude from attempting Bash calls
(e.g. gh pr list) during code review, which causes non-deterministic
failures when permission is denied.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kronosapiens kronosapiens merged commit 346166d into main Feb 17, 2026
12 of 13 checks passed
@kronosapiens kronosapiens deleted the kronosapiens/refine-docs-sync branch February 17, 2026 17:05
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.

2 participants