Skip to content

Normalize report formatting guidelines for daily-repo-chronicle#11764

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-again
Jan 25, 2026
Merged

Normalize report formatting guidelines for daily-repo-chronicle#11764
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-again

Conversation

Copy link
Contributor

Copilot AI commented Jan 25, 2026

The daily-repo-chronicle workflow lacked markdown style guidelines for progressive disclosure, unlike other reporting workflows (audit-workflows, daily-firewall-report).

Changes

Added Report Formatting Guidelines section specifying:

  • Header hierarchy: Use h3 (###) or lower; discussion title serves as h1
  • Progressive disclosure: Wrap detailed content (commit logs, PR lists, verbose stats) in <details> tags
  • Structure pattern: 4-part layout with key info visible, details collapsible
    1. Brief summary (visible)
    2. Key metrics (visible)
    3. Detailed activity (collapsible)
    4. Notable trends (visible)
  • Design principles: Clarity, context, reduced overwhelm, consistency

Updated Editorial Guidelines to reference h3 headers explicitly and note where <details> tags apply.

Example

### 🗞️ Headline News
[Always visible overview...]

### 💻 Commit Chronicles
[Narrative summary...]

<details>
<summary><b>Full Commit Log</b></summary>

[Detailed commit history...]

</details>

Follows established patterns from audit-workflows.md (lines 82-86) and daily-firewall-report.md (lines 147-196).

Original prompt

This section details on the original issue you should resolve

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

Workflow File: .github/workflows/daily-repo-chronicle.md
Issue: This workflow generates daily chronicle 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>Full Activity Details</b></summary>

[Long detailed content here...]

</details>

3. Report Structure

Suggest a structure like:

  • Brief daily summary (always visible)
  • Key highlights and metrics (always visible)
  • Detailed commit/PR/issue activity (in <details> tags)
  • Notable changes or trends (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-repo-chronicle.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)


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

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update report formatting for daily-repo-chronicle Normalize report formatting guidelines for daily-repo-chronicle 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:42
@pelikhan pelikhan merged commit 96ed09f into main Jan 25, 2026
152 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting-again branch January 25, 2026 17:30
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-repo-chronicle

2 participants