Skip to content

[workflow-style] Normalize report formatting for copilot-cli-deep-research #11274

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/copilot-cli-deep-research.md

Issue: This scheduled workflow conducts deep research on Copilot CLI and creates detailed reports, but doesn't include markdown style guidelines. Research reports with extensive findings would greatly benefit from progressive disclosure.

Why This Matters

The copilot-cli-deep-research workflow conducts thorough analysis of Copilot CLI features, usage patterns, and ecosystem. These comprehensive research reports contain multiple sections (findings, analysis, recommendations, technical details) that are perfect candidates for progressive disclosure.

Required Changes

Update the workflow prompt to include these formatting guidelines (add after the research objectives):

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in research reports to maintain proper document hierarchy."

Rationale: Research reports have complex structures (executive summary, detailed findings, methodology, appendices). Proper header levels prevent breaking the document hierarchy.

2. Progressive Disclosure

Add instruction: "Wrap detailed research sections in <details><summary><b>Section Name</b></summary> tags to improve readability and focus."

Example:

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

[Detailed explanation of research methods, data collection, analysis techniques]

</details>

Rationale: Research reports are naturally long and detailed. Progressive disclosure allows readers to get the executive summary and key findings quickly, while deep-dive sections remain accessible but hidden by default.

3. Report Structure

Suggest adding this structure pattern:

### Executive Summary
- **Research Topic**: [topic]
- **Key Findings**: [3-5 main discoveries]
- **Recommendation**: [primary recommendation]

### Critical Findings
[Most important discoveries - always visible for quick scanning]

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

[In-depth analysis with data, charts, technical details]

</details>

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

[Raw data, code examples, test results, screenshots]

</details>

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

[How the research was conducted, tools used, data sources]

</details>

### Recommendations
[Actionable next steps based on findings - keep visible]

### Future Research
[Suggested follow-up topics and questions]

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Executive summary and critical findings immediately visible
  2. Exceed expectations: Include methodology, supporting evidence, future research directions
  3. Create delight: Use progressive disclosure to accommodate both quick readers and deep divers
  4. Maintain consistency: Follow the same patterns as other research/analysis workflows

Import Statement to Add

Add this to the imports: section in the frontmatter:

imports:
  - shared/reporting.md

This automatically loads the formatting guidelines into the agent's context.

Example Reference

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

Agent Task

  1. Add shared/reporting.md to the imports section
  2. Add formatting guidelines to the prompt instructions (emphasize research report structure)
  3. Test by running a research cycle and reviewing the report format
  4. Ensure executive summary and critical findings stay visible while detailed sections are collapsible

AI generated by Workflow Normalizer

  • expires on Jan 29, 2026, 12:27 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationenhancementNew feature or requestworkflow-style

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