reporting

Format report sections as collapsible HTML details and summary blocks.

4.9k|489|Updated Aug 12, 2025
One-click install
npx skills add https://github.com/github/gh-aw --skill reporting-github
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: reporting
Source: https://github.com/github/gh-aw/tree/main/skills/reporting
Command: npx skills add https://github.com/github/gh-aw --skill reporting-github

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps users format long-form reports by wrapping sections in HTML details and summary tags to improve readability and reduce scrolling.

Core Features & Use Cases

  • Standardizes the presentation of reports with collapsible sections for sections like executive summaries, findings, and recommendations.
  • Demonstrates how to structure content using <details> and <summary> tags to enable expand/collapse behavior within Markdown-rendered documents.
  • Use Case: Create a project status report where each section can be expanded for details without overwhelming the reader.

Quick Start

To apply this formatting, wrap relevant report sections with HTML details/summary. For example:

<details> <summary>📊 Report Title - [Date]</summary>

Report Content

Your detailed report content goes here...

Section 1

Content for section 1...

Section 2

Content for section 2...

</details>

Frequently Asked Questions about reporting

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format long-form reports with collapsible sections in Markdown?▼

You can format long-form reports with collapsible sections in Markdown by wrapping content blocks in standard HTML <details> and <summary> tags, creating expandable sections that reduce scrolling and improve overall document readability.

What is the best way to structure a project status report to avoid overwhelming the reader?▼

The best way to structure a project status report is using HTML details and summary tags to create collapsible sections for executive summaries, findings, and recommendations, allowing readers to expand only the details they need.

Do I need external software or dependencies to create expandable content blocks in documentation?▼

No external software or dependencies are needed to create expandable content blocks in documentation. The formatting relies entirely on standard HTML tags and plain-text instructions within Markdown-rendered documents.

How does using HTML details tags improve report readability?▼

Using HTML details tags improves report readability by standardizing long-form updates into concise overviews. It enables expand and collapse behavior, hiding extensive findings until the user actively requests them.

Can I use standard HTML tags to create collapsible executive summaries in status reports?▼

Yes, you can use standard HTML tags to create collapsible executive summaries in status reports. Wrapping summary text in <details> and <summary> tags provides practical formatting for expandable content blocks.