[workflow-style] Normalize report formatting for daily-multi-device-docs-tester

[github-actions]

Workflow to Update

Workflow File: .github/workflows/daily-multi-device-docs-tester.md
Issue: This workflow generates test result discussions but doesn't include markdown style guidelines

Required Changes

Update the workflow prompt to include formatting guidelines. Add after the workflow overview section:

## Report Formatting Guidelines

**CRITICAL**: Follow these formatting guidelines to create well-structured, readable reports:

### 1. Header Levels
**Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.**

The discussion title serves as h1, so all content headers should start at h3:
- Use `###` for main sections (e.g., "### Test Summary", "### Results by Device")
- Use `####` for subsections (e.g., "#### Desktop Results", "#### Mobile Results")
- Never use `##` (h2) or `#` (h1) in the report body

### 2. Progressive Disclosure
**Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.**

Use collapsible sections for:
- Full test output logs and error traces
- Per-device detailed test results
- Complete screenshot galleries
- Verbose configuration and environment details

Example:
``````markdown
<details>
<summary><b>Device-Specific Test Results</b></summary>

### iPhone 15 Pro (iOS 17)

**Status**: ✅ All tests passed
[Detailed results...]

### Samsung Galaxy S23 (Android 14)

**Status**: ⚠️ 2 warnings
[Detailed results...]

</details>

3. Report Structure Pattern

Your discussion should follow this structure for optimal readability:

1. Test Summary (always visible): Brief overview of total tests run, pass/fail counts, critical issues
2. Results Overview (always visible): High-level status for each device type (desktop, mobile, tablet)
3. Detailed Device Results (in <details> tags): Per-device test logs, screenshots, error traces
4. Recommendations (always visible): Action items to fix failing tests or improve coverage

Design Principles

Create reports that:

• Build trust through clarity: Most important info (summary, pass/fail status) immediately visible
• Exceed expectations: Add helpful context like screenshots, error analysis, comparison to previous runs
• Create delight: Use progressive disclosure to reduce overwhelm from verbose test output
• Maintain consistency: Follow the same patterns as other testing workflows

#### Add Report Template

Include an example template showing the expected structure:

``````markdown
## Discussion Report Template

``````markdown
### 📊 Test Summary

- **Total Devices Tested**: [NUMBER]
- **Tests Passed**: [NUMBER] ✅
- **Tests Failed**: [NUMBER] ❌
- **Warnings**: [NUMBER] ⚠️
- **Overall Status**: [✅ PASS / ❌ FAIL / ⚠️ PARTIAL]

### 🖥️ Results by Device Category

#### Desktop Browsers

| Device | Browser | Status | Issues |
|--------|---------|--------|--------|
| Windows 11 | Chrome 120 | ✅ | 0 |
| macOS 14 | Safari 17 | ⚠️ | 1 warning |
| Linux | Firefox 121 | ✅ | 0 |

#### Mobile Devices

| Device | OS | Status | Issues |
|--------|-----|--------|--------|
| iPhone 15 Pro | iOS 17 | ✅ | 0 |
| Galaxy S23 | Android 14 | ❌ | 1 failure |
| iPad Air | iPadOS 17 | ✅ | 0 |

### 🚨 Critical Issues

[List any failing tests or critical problems - always visible]

1. **Galaxy S23 (Android 14)**: Navigation menu not responsive
   - Error: [Brief error description]
   - Screenshot: [URL]

<details>
<summary><b>View Full Test Results by Device</b></summary>

### Desktop: Windows 11 - Chrome 120

**Status**: ✅ All tests passed

**Tests Run**:
- [ x ] Page loads correctly
- [ x ] Navigation works
- [ x ] Search functionality
- [ x ] Images render properly
- [ x ] Responsive layout

**Performance**:
- Load time: 2.3s
- Interactive: 3.1s
- Accessibility: 98/100

**Screenshots**:
![Homepage](URL)
![Documentation](URL)

---

### Mobile: iPhone 15 Pro - iOS 17

[Similar detailed breakdown...]

---

### Mobile: Samsung Galaxy S23 - Android 14

**Status**: ❌ Failed

**Tests Run**:
- [x] Page loads correctly
- [ ] Navigation works ❌
- [x] Search functionality
- [x] Images render properly
- [ ] Responsive layout ⚠️

**Error Log**:

[Full error trace here...]

**Screenshots**:
![Error Screenshot](URL)

[Continue for all devices...]

</details>

<details>
<summary><b>Test Configuration &amp; Environment</b></summary>

### Playwright Configuration

``````yaml
[Configuration details...]

Environment Variables

• Base URL: [URL]
• Timeout: [VALUE]
• Retries: [VALUE]

✅ Recommendations

1. Fix Galaxy S23 navigation issue: [Specific steps]
2. Investigate iPad Pro warning: [Specific steps]
3. Add test coverage: [Suggestions]

📈 Trends (If Available)

• Comparison to previous test run
• New failures introduced
• Fixed issues

---

Report generated automatically by the Daily Multi-Device Docs Tester workflow

Example Reference

See workflows like daily-issues-report or weekly-issue-summary for good examples of test result reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/daily-multi-device-docs-tester.md to include the formatting guidelines above.

AI generated by Workflow Normalizer

• expires on Feb 8, 2026, 12:29 PM UTC