Skip to content

[workflow-style] Normalize report formatting for archie workflow #22438

@github-actions

Description

@github-actions

Workflows to Update

The following workflow generates report comments but embeds a non-compliant header level in its comment template:

Workflow File Issues Found
.github/workflows/archie.md Comment template uses h2 (##) header; no progressive disclosure (<details>) instructions

Required Changes

.github/workflows/archie.md

The embedded Comment Structure template in the workflow uses an h2 header and does not instruct the agent to use h3+ headers or <details> tags for progressive disclosure.

Current template (non-compliant):

## 📊 Mermaid Diagram Analysis

*Generated by Archie for @...*

### [Diagram 1 Title]
...

Required template (compliant):

### 📊 Mermaid Diagram Analysis

*Generated by Archie for @...*

#### [Diagram 1 Title]
...

1. Header Levels

Replace the h2 (##) header in the Comment Structure template with h3 (###), and update diagram title placeholders from ### [Diagram N Title] to #### [Diagram N Title].

Add an explicit instruction before the template:

Comment Formatting: Use h3 (###) or lower for all headers in your comment to maintain proper document hierarchy. The comment has no implicit title, so start section headers at h3.

2. Progressive Disclosure

For cases where multiple diagrams are generated, add guidance to wrap them in <details> tags so the most important diagram is immediately visible:

If generating multiple diagrams, wrap diagrams 2 and 3 in <details><summary><b>View Additional Diagrams</b></summary> tags to reduce scrolling.

Example:

<details>
<summary><b>View Additional Diagrams</b></summary>

#### [Diagram 2 Title]

[Brief description]

```mermaid
[diagram code]
```

Design Principles (Airbnb-Inspired)

The updated workflow should create comments that:

  1. Build trust through clarity: Primary diagram immediately visible
  2. Exceed expectations: Multiple diagrams with descriptions
  3. Create delight: Use progressive disclosure for secondary diagrams
  4. Maintain consistency: Match h3+ style used across other reporting workflows

Reference — Compliant Workflows

These workflows already follow the guidelines:

  • .github/workflows/daily-file-diet.md — See "Markdown Formatting Guidelines" section
  • .github/workflows/cli-consistency-checker.md — See "Report Formatting" instruction block
  • .github/workflows/repository-quality-improver.md — See "Report Formatting" instruction block

Compliance Summary (Last 24h)

Workflow Status Notes
archie.md ⚠️ Needs improvement h2 in comment template; no h3+/<details> guidance
repository-quality-improver.md ✅ Compliant Explicit h3+ and reporting MCP guidance
ci-coach.md ✅ Compliant Explicit h3+ and <details> example in PR template
cli-consistency-checker.md ✅ Compliant Explicit h3+ and <details> instructions
daily-file-diet.md ✅ Compliant Explicit h3+ and <details> instructions
issue-monster.md ✅ N/A Issue assignment workflow, not a report generator
ai-moderator.md ✅ N/A Moderation workflow, not a report generator

Agent Task

Update .github/workflows/archie.md:

  1. Change ## 📊 Mermaid Diagram Analysis to ### 📊 Mermaid Diagram Analysis in the Comment Structure template
  2. Change diagram title placeholders from ### [Diagram N Title] to #### [Diagram N Title]
  3. Add a "Comment Formatting" instruction before the template block
  4. Add <details> wrapping guidance for secondary diagrams
  5. Run make recompile after updating the markdown file

References:

  • §23440699111 — Workflow Normalizer run that identified this issue

Generated by Workflow Normalizer ·

  • expires on Mar 24, 2026, 1:58 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions