-
Notifications
You must be signed in to change notification settings - Fork 43
Description
Workflow to Update
Workflow File: .github/workflows/blog-auditor.md
Issue: This workflow creates audit reports but doesn't include markdown style guidelines in its prompt instructions.
Required Changes
Update the workflow prompt to include formatting guidelines for the audit report:
1. Header Levels
Add instruction in the report creation section:
Markdown Formatting: Use h3 (###) or lower for all headers in your audit report to maintain proper document hierarchy.
Example structure:
### Audit Summary
- Files audited: X
- Issues found: Y
- Status: ✅/⚠️/❌
### Critical Findings
[Always visible - most important issues]
<details>
<summary><b>View Detailed Findings by File</b></summary>
#### File: post-1.md
- Issue 1...
- Issue 2...
#### File: post-2.md
- Issue 1...
</details>
### Recommendations
[Always visible - action items]2. Progressive Disclosure
Add instruction for handling long audit results:
Progressive Disclosure: Wrap detailed file-by-file findings in <details><summary><b>Section Name</b></summary> tags. Keep the summary, critical issues, and recommendations visible.
3. Audit Report Structure
Suggest consistent structure:
- Audit Summary: Key metrics (always visible)
- Critical Findings: Most important issues (always visible)
- Detailed Findings: File-by-file breakdown (in
<details>tags) - Trends and Patterns: Analysis across files (in
<details>tags) - Recommendations: Prioritized action items (always visible)
Design Principles (Airbnb-Inspired)
The updated workflow should create reports that:
- Build trust through clarity: Summary and critical findings immediately visible
- Exceed expectations: Include trends, comparisons with previous audits
- Create delight: Easy to scan, details available when needed
- Maintain consistency: Follow patterns from other audit workflows
Example Reference
See workflows like audit-workflows or repo-audit-analyzer for good examples of structured audit reports.
Verification
After updating, test by:
- Running the blog-auditor workflow
- Verifying the report uses h3+ headers
- Checking that detailed findings use
<details>tags - Confirming the report is easy to navigate
AI generated by Workflow Normalizer
- expires on Feb 7, 2026, 12:24 PM UTC