Merge pull request #614 from AztecProtocol/fix/doc-suggestions-workflow

fix: doc-suggestions workflow and report completeness

Author: critesjosh

.github/workflows/doc-suggestions.yml

@@ -89,7 +89,7 @@ jobs:
           MEDIUM=$(grep -c "^### Medium Priority" "reports/doc-suggestions-${DATE}.md" || echo "0")
           LOW=$(grep -c "^### Low Priority" "reports/doc-suggestions-${DATE}.md" || echo "0")
 
-          # Create PR and assign to DevRel team
+          # Create PR and request review from DevRel team
           gh pr create \
             --title "docs: Documentation suggestions for ${DATE}" \
             --body "## Documentation Update Suggestions
@@ -105,4 +105,4 @@ jobs:
 
           ---
           🤖 Generated by the doc-suggestions tool" \
-            --assignee "@AztecProtocol/devrel"
+            --reviewer "AztecProtocol/devrel"

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

@@ -70,11 +70,29 @@ Please update the documentation file to reflect these changes.
   if (suggestions.length === 0) {
     report += `## No Suggestions
 
-No documentation updates needed at this time. All referenced source files are either:
-- Unchanged in the scan period
-- Already have up-to-date documentation
+No documentation updates needed at this time.
 
 `;
+
+    // Show what was analyzed even when no updates needed
+    if (analysisResult.staleReferences.length > 0) {
+      report += `### Reviewed References
+
+The following documentation files were flagged for review but determined to not need updates:
+
+| Documentation | Referenced Source | Reason |
+|--------------|-------------------|--------|
+`;
+      for (const ref of analysisResult.staleReferences) {
+        const prLink = ref.recentSourceChanges.find((c) => c.pr_number)?.pr_number;
+        const prText = prLink ? `PR #${prLink}` : 'Recent commits';
+        report += `| \`${ref.docPath}\` | \`${ref.sourceFile}\` | ${prText} - no user-facing changes |
+`;
+      }
+      report += `
+`;
+    }
+
     return report;
   }