Skip to content

Add markdown formatting guidelines to daily-copilot-token-report workflow#12423

Merged
pelikhan merged 3 commits intomainfrom
copilot/normalize-report-formatting
Jan 29, 2026
Merged

Add markdown formatting guidelines to daily-copilot-token-report workflow#12423
pelikhan merged 3 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

The daily-copilot-token-report workflow generates reports without guidance on document hierarchy and progressive disclosure, leading to inconsistent formatting across reporting workflows.

Changes

  • Added formatting guidelines after Mission section (lines 78-126)

    • Header levels: h3+ only (discussion title is h1)
    • Progressive disclosure: <details> tags for verbose sections
    • Report structure pattern: 5-section template (summary, highlights, trends, details, recommendations)
    • Design principles: consistency with daily-team-status and weekly-issue-summary
  • Updated report template (lines 555-674)

    • All h2 headers → h3/h4
    • Wrapped detailed sections in collapsible <details> blocks:
      • Per-workflow statistics (all workflows)
      • Optimization opportunities
      • Efficiency trends
      • Historical comparison
      • Methodology & data quality notes
    • Key insights remain always-visible

Example

Before:

## Executive Summary
...
## 📈 Token Usage Trends

After:

### Executive Summary
...
### 📈 Token Usage Trends

<details>
<summary><b>Per-Workflow Detailed Statistics</b></summary>
...
</details>

Maintains consistency with existing reporting workflows and improves report readability through proper document hierarchy.

Original prompt

This section details on the original issue you should resolve

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

Workflow File: .github/workflows/daily-copilot-token-report.md
Issue: This workflow generates daily token consumption 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 line 62 (in the "Mission" section):

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., "### Token Consumption Overview", "### Per-Workflow Statistics")
  • Use #### for subsections (e.g., "#### Top 10 Most Expensive Workflows", "#### Cost Trends")
  • 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:

  • Per-workflow detailed statistics tables
  • Full workflow run lists
  • Historical comparison data
  • Verbose metrics breakdowns

Example:

<details>
<summary><b>Per-Workflow Detailed Statistics</b></summary>

| Workflow | Runs | Total Tokens | Avg Tokens | Total Cost | Avg Cost |
|----------|------|--------------|------------|------------|----------|
| workflow-1 | 25 | 1,234,567 | 49,382 | $1.23 | $0.05 |
| ... | ... | ... | ... | ... | ... |

</details>

3. Report Structure

Suggest this structure for optimal readability:

  1. Executive Summary (always visible): Brief overview of total token usage, costs, and key findings
  2. Key Highlights (always visible): Top 5 most expensive workflows, notable cost increases/decreases
  3. Visual Trends (always visible): Embedded charts showing token usage and cost trends
  4. Detailed Per-Workflow Statistics (in <details> tags): Complete breakdown for all workflows
  5. Recommendations (always visible): Actionable suggestions for optimization

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important info (summary, top consumers, trends) immediately visible
  2. Exceed expectations: Add helpful context like week-over-week comparisons, cost projections
  3. Create delight: Use progressive disclosure to reduce overwhelm while keeping details accessible
  4. Maintain consistency: Follow the same patterns as other reporting workflows like daily-issues-report and daily-team-status

Example Reference

See workflows like daily-team-status.md (lines 52-97) and weekly-issue-summary.md (lines 144-190) for good examples of structured reporting with header guidelines and progressive disclosure.

Agent Task

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

AI generated by Workflow Normalizer

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

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


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 29, 2026 02:50
…-report

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for daily copilot token report Add markdown formatting guidelines to daily-copilot-token-report workflow Jan 29, 2026
Copilot AI requested a review from pelikhan January 29, 2026 03:00
@pelikhan pelikhan marked this pull request as ready for review January 29, 2026 03:01
@pelikhan pelikhan merged commit 70332ac into main Jan 29, 2026
151 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch January 29, 2026 03:06
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-copilot-token-report

2 participants