Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 25, 2026

The daily-observability-report workflow generates unstructured reports without guidance on progressive disclosure, making them difficult to scan.

Changes

  • Added formatting guidelines section with three requirements:

    • Header hierarchy: Use h3/h4 only (discussion title is h1)
    • Progressive disclosure: Wrap detailed data in <details> tags
    • 5-part structure: Executive summary, alerts, coverage metrics (visible) + detailed analysis, telemetry quality (collapsed)
  • Updated discussion template to follow the structure:

    ### Executive Summary
    [2-3 paragraphs - always visible]
    
    ### Coverage Summary
    | Component | Coverage | Status |
    [Always visible metrics table]
    
    <details>
    <summary><b>📋 Detailed Run Analysis</b></summary>
    [Per-run breakdown, logs analysis]
    </details>
    
    ### Recommended Actions
    [Always visible recommendations]
  • Added design principles mirroring patterns from audit-workflows and daily-firewall-report for consistency

The workflow now guides agents to generate scannable reports with critical information visible and verbose data collapsed.

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for daily-observability-report</issue_title>
<issue_description>### Workflow to Update

Workflow File: .github/workflows/daily-observability-report.md
Issue: This workflow generates daily observability reports but doesn't include markdown style guidelines for progressive disclosure

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."

2. Progressive Disclosure

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

Example:

<details>
<summary><b>Detailed Metrics</b></summary>

[Long metrics data...]

</details>

3. Report Structure

Suggest a structure like:

  • Executive summary of observability status (always visible)
  • Key alerts and anomalies (always visible)
  • Detailed metrics and logs (in <details> tags)
  • Recommended actions (always visible)

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like audit-workflows or daily-firewall-report for good examples of structured reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/daily-observability-report.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.

AI generated by Workflow Normalizer

  • expires on Feb 1, 2026, 12:23 PM UTC

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…flow

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update daily observability report formatting guidelines Add report formatting guidelines to daily-observability-report workflow Jan 25, 2026
Copilot AI requested a review from pelikhan January 25, 2026 14:07
@pelikhan pelikhan marked this pull request as ready for review January 25, 2026 15:36
@pelikhan pelikhan merged commit a5b1073 into main Jan 25, 2026
@pelikhan pelikhan deleted the copilot/update-report-formatting-workflow branch January 25, 2026 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[workflow-style] Normalize report formatting for daily-observability-report

2 participants