diff --git a/.github/aw/report.md b/.github/aw/report.md index 4fa1fb2d1f..237b24841b 100644 --- a/.github/aw/report.md +++ b/.github/aw/report.md @@ -40,23 +40,18 @@ safe-outputs: ### Header Levels -**Use `###` or lower for all headers in your report to maintain proper document hierarchy.** - -When creating GitHub issues or discussions: -- Use `###` (h3) for main sections (e.g., `### Test Summary`) -- Use `####` (h4) for subsections (e.g., `#### Device-Specific Results`) -- Never use `##` (h2) or `#` (h1) in reports — these are reserved for titles +- Use `###` (h3) for main sections — e.g., `### Test Summary` +- Use `####` (h4) for subsections — e.g., `#### Device-Specific Results` +- Never use `##` (h2) or `#` (h1) — those are reserved for titles ### Progressive Disclosure -**Wrap detailed content in `
Section Name` tags to improve readability and reduce scrolling.** - -Use collapsible sections for: +Wrap detailed content in `
Section Name` tags. Use for: - Verbose details (full logs, raw data) - Secondary information (minor warnings, extra context) - Per-item breakdowns when there are many items -Always keep critical information visible (summary, critical issues, key metrics). +Keep critical information visible (summary, critical issues, key metrics). ### Report Structure Pattern @@ -65,14 +60,6 @@ Always keep critical information visible (summary, critical issues, key metrics) 3. **Details**: Use `
Section Name` for expanded content 4. **Context**: Add helpful metadata (workflow run, date, trigger) -### Design Principles - -Reports should: -- **Build trust through clarity**: Most important info immediately visible -- **Exceed expectations**: Add helpful context like trends, comparisons -- **Create delight**: Use progressive disclosure to reduce overwhelm -- **Maintain consistency**: Follow patterns across all reports - ### Example Report Structure ```markdown