feat: Add Claude-powered documentation suggestions tool #613
Conversation
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
Adds a nightly job that scans aztec-packages for source code changes and generates suggestions for documentation updates using Claude. Features: - Scans recent commits for file changes on the configured branch - Identifies docs with `references:` frontmatter pointing to changed files - Uses Claude to analyze changes and suggest documentation updates - Generates prioritized markdown reports for DevRel review - Reports can be fed directly to Claude Code for making updates Configuration: - GITHUB_TOKEN: Required for GitHub API access - ANTHROPIC_API_KEY: Required for Claude API - BRANCH: Target branch (default: next for aztec-packages) - LOOKBACK_DAYS: Days to scan (default: 7) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
critesjosh
force-pushed
the
jc/docs-source-reviewer
branch
from
3421c0c to
7d59bff
Compare
critesjosh
commented
Jan 9, 2026
| inputs: | ||
| lookback_days: | ||
| description: 'Number of days to look back for changes' | ||
| default: '7' |
Collaborator
Author
There was a problem hiding this comment.
maybe this should be 1. or we could run it twice a week?
sklppy88
approved these changes
Jan 12, 2026
sklppy88
left a comment
sklppy88
left a comment
There was a problem hiding this comment.
looks good, you can merge this is you want because i think as per our meet i will just build on top of this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
aztec-packagesfor source code changes and generates suggestions for documentation updates using ClaudeHow It Works
next)references:frontmatter pointing to changed filesFiles Added
tooling/doc-suggestions/src/index.tstooling/doc-suggestions/src/github-scanner.tstooling/doc-suggestions/src/reference-analyzer.tstooling/doc-suggestions/src/claude-client.tstooling/doc-suggestions/src/report-generator.ts.github/workflows/doc-suggestions.ymlConfiguration
GITHUB_TOKENANTHROPIC_API_KEYBRANCHnextLOOKBACK_DAYS7Secrets Required
ANTHROPIC_API_KEYneeds to be added to the repo secretsTest plan
🤖 Generated with Claude Code