Skip to content

Improve Daily Reliability Review readability with progressive disclosure #33523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mnkiefer merged 4 commits into from
May 20, 2026
+12 −0
Merged

Improve Daily Reliability Review readability with progressive disclosure #33523

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
920cce3
Initial plan
Copilot May 20, 2026
e1954b4
Improve daily reliability report progressive disclosure formatting
Copilot May 20, 2026
3b053af
Polish disclosure headings in daily reliability report template
Copilot May 20, 2026
8209e99
Refine collapsible section labels in reliability report template
Copilot May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/daily-reliability-review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ Title:

Body structure:

Use progressive disclosure. Keep `Executive Summary`, `Top Reliability Findings`, and `Recommendations` always visible. Put verbose evidence and supporting detail inside `<details><summary>...</summary>` blocks.
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The progressive disclosure guidance says to keep certain sections "always visible" and wrap "verbose evidence and supporting detail" in <details> blocks.

Consider being more explicit about which sections should never be collapsed to avoid ambiguity:

Use progressive disclosure. Keep `Executive Summary`, `Top Reliability Findings`, and `Recommendations` **always expanded** (never wrap these in `<details>` blocks). Put verbose evidence and supporting detail (`Representative Traces`, `Notes`) inside `<details><summary>...</summary>` blocks.

This makes it clearer that the three named sections are exempt from collapsing, reducing the risk of the AI agent misinterpreting the instruction.

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The phrase "progressive disclosure" is a UX pattern name, but the workflow prompt uses domain-specific terminology elsewhere ("reliability engineer", "observability telemetry", "trace continuity"). Consider whether this instruction would be clearer using the existing vocabulary:

Use collapsible sections to keep the report scannable. Keep `Executive Summary`, `Top Reliability Findings`, and `Recommendations` always visible. Put verbose evidence and supporting detail inside `<details><summary>...</summary>` blocks.

This avoids introducing a new concept ("progressive disclosure") when the concrete instruction ("collapsible sections") is already clear and consistent with the reporting skill guidance.


### Executive Summary
- Overall health for the last 24 hours.

Expand All @@ -111,14 +113,24 @@ Body structure:
| ... | ... | ... | ... | ... |

### Representative Traces
<details>
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The <details> blocks are always applied in the template, but the guidance doesn't specify when they should be used.

Consider adding conditional guidance for when to collapse sections:

<details>
<summary>View representative traces</summary>

- Include one trace or issue link for each major problem class when available.
- Collapse this section if there are more than 3 traces to keep the issue body scannable.

</details>

This helps the AI agent decide whether to use the collapse feature based on content volume, not just structure.

<summary>View representative traces</summary>
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The summary text "View representative traces" is clear, but consider making it even more actionable by including a count hint when possible:

<summary>View representative traces (one per problem class)</summary>

This reinforces the instruction within the collapsed section and helps the AI agent understand the expected scope without expanding the details block. Other daily workflows use this pattern (e.g., daily-observability-report.md has context hints in summary labels).


- Include one trace or issue link for each major problem class when available.

</details>

### Recommendations
- 2-4 concrete actions with the smallest useful fixes first.

### Notes
<details>
<summary>View notes</summary>

- Call out missing telemetry, ambiguous fields, or inconclusive results.

</details>

## Guardrails

- If no reliability issues are found, call `noop` with a concise summary of what was checked.
Expand Down
Loading