Skip to content

[workflow-style] Normalize report formatting for blog-auditor #13272

@github-actions

Description

@github-actions

Workflow File: .github/workflows/blog-auditor.md

This workflow audits blog content and generates reports but doesn't include markdown style guidelines, which can lead to inconsistent formatting and poor readability.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy."

Blog audit reports need clear organization. All content headers should start at h3:

  • Use ### for main sections (e.g., "### Audit Summary", "### Content Issues")
  • Use #### for subsections (e.g., "#### Broken Links", "#### Style Violations")
  • Never use ## (h2) or # (h1) in the report body

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Use collapsible sections for:

  • Full lists of broken links
  • Detailed content analysis per blog post
  • Complete style check results
  • Verbose quality metrics

Example:

<details>
<summary><b>View All Broken Links</b></summary>

[Complete list of broken links by blog post...]

</details>

3. Report Structure

Suggest a structure like:

  1. Brief summary (always visible): Blog posts audited, critical issues found
  2. Key findings (always visible): Most important content issues requiring attention
  3. Detailed audit results (in <details> tags): Per-post analysis, link checks, style violations
  4. Recommendations (always visible): Actionable steps to improve blog content quality

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important content issues immediately visible
  2. Exceed expectations: Add context like trends, fix priorities, quality scores
  3. Create delight: Use progressive disclosure to make comprehensive audits digestible
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-repo-chronicle.md or audit-workflows.md for good examples of structured reporting.

Agent Task

Update the workflow file .github/workflows/blog-auditor.md to include the formatting guidelines above. Test to ensure well-formatted audit reports.

AI generated by Workflow Normalizer

  • expires on Feb 9, 2026, 12:31 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions