Skip to content

[workflow-style] Normalize report formatting for deep-report #12914

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/deep-report.md

Issue: This workflow creates comprehensive analysis reports but doesn't include markdown style guidelines in its prompt instructions.

Required Changes

Update the workflow prompt to include formatting guidelines for the deep report:

1. Header Levels

Add instruction in the report generation section:

Markdown Formatting: Use h3 (###) or lower for all headers in your deep analysis report to maintain proper document hierarchy. Since this report can be quite long, proper structure is critical.

Example structure:

### Executive Summary
[2-3 paragraphs with key findings - always visible]

### Key Insights
- Insight 1
- Insight 2
- Insight 3

### Critical Findings
[Most important discoveries - always visible]

<details>
<summary><b>View Detailed Analysis</b></summary>

#### Code Quality Analysis
[In-depth findings...]

#### Performance Analysis
[Detailed metrics...]

#### Security Analysis
[Security review...]

</details>

<details>
<summary><b>View Supporting Data</b></summary>

[Tables, charts, raw data...]

</details>

<details>
<summary><b>View Methodology</b></summary>

[How the analysis was performed...]

</details>

### Recommendations
[Prioritized action items - always visible]

### Next Steps
[Clear path forward - always visible]

2. Progressive Disclosure

Add instruction for handling comprehensive reports:

Progressive Disclosure: Deep reports contain extensive analysis. Wrap detailed findings, supporting data, and methodology in <details><summary><b>Section Name</b></summary> tags. Keep the executive summary, key insights, and recommendations visible for quick scanning.

3. Report Structure

Suggest consistent structure for deep reports:

  • Executive Summary: 2-3 paragraph overview (always visible)
  • Key Insights: Bullet-point highlights (always visible)
  • Critical Findings: Most important discoveries (always visible)
  • Detailed Analysis: In-depth findings by category (in <details> tags)
  • Supporting Data: Tables, metrics, charts (in <details> tags)
  • Methodology: How analysis was done (in <details> tags)
  • Recommendations: Prioritized actions (always visible)
  • Next Steps: Clear path forward (always visible)

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Executive summary and key insights immediately visible
  2. Exceed expectations: Comprehensive analysis available when needed
  3. Create delight: Easy to scan at high level, dive deep when interested
  4. Maintain consistency: Follow patterns from other analysis workflows

Example Reference

See workflows like daily-observability-report or copilot-agent-analysis for good examples of structured deep analysis reports.

Verification

After updating, test by:

  1. Running the deep-report workflow
  2. Verifying the report uses h3+ headers throughout
  3. Checking that detailed sections use <details> tags
  4. Confirming the report is scannable while preserving depth
  5. Testing that key information is visible without expanding sections

AI generated by Workflow Normalizer

  • expires on Feb 7, 2026, 12:24 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions