Skip to content

[workflow-style] Normalize report formatting for daily-regulatory #12255

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/daily-regulatory.md
Issue: This workflow generates regulatory reports that monitor other daily reports but doesn't include markdown style guidelines for proper document hierarchy and progressive disclosure.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction after the "Mission" section (after line 48):

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

The discussion title serves as h1, so all content headers should start at h3:

  • Use ### for main sections (e.g., "### Regulatory Summary", "### Cross-Report Consistency Check")
  • Use #### for subsections (e.g., "#### Metric Discrepancies", "#### Anomalies Detected")
  • Never use ## (h2) or # (h1) in the report body

2. Progressive Disclosure

Add instruction for using collapsible sections:

Wrap detailed sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling.

Use collapsible sections for:

  • Detailed metric comparison tables across all reports
  • Per-report analysis breakdowns
  • Historical anomaly logs
  • Full data validation results

Example:

<details>
<summary><b>Detailed Metric Comparison</b></summary>

### Issues Report vs Code Metrics Report

| Metric | Issues Report | Code Metrics | Difference | Status |
|--------|--------------|--------------|------------|--------|
| Open Issues | 245 | 248 | +3 | ⚠️ Minor discrepancy |
| ... | ... | ... | ... | ... |

</details>

3. Report Structure

Suggest this structure for optimal readability:

  1. Regulatory Overview (always visible): Brief summary of compliance status, critical issues
  2. Critical Findings (always visible): Anomalies, discrepancies, or concerns requiring immediate attention
  3. Detailed Analysis (in <details> tags): Complete metric comparisons, validation results
  4. Recommendations (always visible): Actionable next steps to address issues

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Critical findings and compliance status immediately visible
  2. Exceed expectations: Add context about why discrepancies matter, suggest root causes
  3. Create delight: Use progressive disclosure to show detailed analysis without overwhelming
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-issues-report.md (lines 248-256) and daily-code-metrics.md (lines 239-247) for good examples of structured reporting with header guidelines and progressive disclosure.

Important Note

This workflow already has comprehensive prerequisite checks (lines 59-98). The formatting guidelines should be added after the prerequisites section but before the main analysis phases to ensure the report structure is clear when creating the regulatory discussion.

Agent Task

Update the workflow file .github/workflows/daily-regulatory.md to include the formatting guidelines above. Add them after the "Mission" section and before "Phase 0: Prerequisites Check". Test the updated workflow to ensure it produces well-formatted regulatory reports with proper header hierarchy and progressive disclosure.

AI generated by Workflow Normalizer

  • expires on Feb 4, 2026, 12:26 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions