Skip to content

Apply progressive disclosure to comment-memory disclosure note#28438

Merged
pelikhan merged 1 commit intomainfrom
copilot/apply-progressive-disclosure-comment-note
Apr 25, 2026
Merged

Apply progressive disclosure to comment-memory disclosure note#28438
pelikhan merged 1 commit intomainfrom
copilot/apply-progressive-disclosure-comment-note

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 25, 2026

The comment-memory disclosure note was fully expanded on every managed comment, adding visual noise for readers who already understand what it is.

Changes

  • actions/setup/md/comment_memory_disclosure_note.md: Wraps the explanation text in <details>/<summary> inside the [!NOTE] callout — summary line stays visible, detail text collapses by default. Adds a link to the glossary docs in the collapsed body.

Before:

> [!NOTE]
> This comment is managed by comment memory.
>
> It stores persistent context for this thread in the code block at the top of this comment.
> Edit only the text inside the backtick fences; workflow metadata and the footer are regenerated automatically.

After:

> [!NOTE]
> <details>
> <summary>This comment is managed by comment memory.</summary>
>
> It stores persistent context for this thread in the code block at the top of this comment.
> Edit only the text inside the backtick fences; workflow metadata and the footer are regenerated automatically.
>
> [Learn more about comment memory](https://github.github.com/gh-aw/reference/glossary/#comment-memory)
>
> </details>

@pelikhan pelikhan marked this pull request as ready for review April 25, 2026 11:40
Copilot AI review requested due to automatic review settings April 25, 2026 11:40
@pelikhan pelikhan merged commit 1d2008c into main Apr 25, 2026
9 checks passed
@pelikhan pelikhan deleted the copilot/apply-progressive-disclosure-comment-note branch April 25, 2026 11:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the comment-memory disclosure note to reduce visual noise by collapsing the explanatory text behind a progressive disclosure control.

Changes:

  • Wrap the note body in <details>/<summary> so only the one-line summary is shown by default.
  • Add a “Learn more” link to the comment-memory glossary entry inside the collapsed content.
Show a summary per file
File Description
actions/setup/md/comment_memory_disclosure_note.md Converts the disclosure note to a collapsible <details> block and adds a glossary link to keep managed comments more compact.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@github-actions github-actions Bot mentioned this pull request Apr 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants