Skip to content

Commit 60a68bb

Browse files
critesjoshclaude
andcommitted
fix: doc-suggestions workflow and report completeness
- Change --assignee to --reviewer for DevRel team notification (GitHub assignees only work with individual users, not teams) - Show reviewed references in report even when no updates needed so reviewers can see what was analyzed Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 2179059 commit 60a68bb

2 files changed

Lines changed: 23 additions & 5 deletions

File tree

.github/workflows/doc-suggestions.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ jobs:
8989
MEDIUM=$(grep -c "^### Medium Priority" "reports/doc-suggestions-${DATE}.md" || echo "0")
9090
LOW=$(grep -c "^### Low Priority" "reports/doc-suggestions-${DATE}.md" || echo "0")
9191
92-
# Create PR and assign to DevRel team
92+
# Create PR and request review from DevRel team
9393
gh pr create \
9494
--title "docs: Documentation suggestions for ${DATE}" \
9595
--body "## Documentation Update Suggestions
@@ -105,4 +105,4 @@ jobs:
105105
106106
---
107107
🤖 Generated by the doc-suggestions tool" \
108-
--assignee "@AztecProtocol/devrel"
108+
--reviewer "AztecProtocol/devrel"

tooling/doc-suggestions/src/report-generator.ts

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,29 @@ Please update the documentation file to reflect these changes.
7070
if (suggestions.length === 0) {
7171
report += `## No Suggestions
7272
73-
No documentation updates needed at this time. All referenced source files are either:
74-
- Unchanged in the scan period
75-
- Already have up-to-date documentation
73+
No documentation updates needed at this time.
7674
7775
`;
76+
77+
// Show what was analyzed even when no updates needed
78+
if (analysisResult.staleReferences.length > 0) {
79+
report += `### Reviewed References
80+
81+
The following documentation files were flagged for review but determined to not need updates:
82+
83+
| Documentation | Referenced Source | Reason |
84+
|--------------|-------------------|--------|
85+
`;
86+
for (const ref of analysisResult.staleReferences) {
87+
const prLink = ref.recentSourceChanges.find((c) => c.pr_number)?.pr_number;
88+
const prText = prLink ? `PR #${prLink}` : 'Recent commits';
89+
report += `| \`${ref.docPath}\` | \`${ref.sourceFile}\` | ${prText} - no user-facing changes |
90+
`;
91+
}
92+
report += `
93+
`;
94+
}
95+
7896
return report;
7997
}
8098

0 commit comments

Comments
 (0)