Document PR dashboard guidance comment#16
Merged
maryliag merged 1 commit intoJun 25, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents the dashboard's one-time PR guidance comment and removes the duplicate implementation README at .github/scripts/pull-request-dashboard/README.md, leaving the root pull-request-dashboard/README.md as the single source of truth. The change is documentation-only and does not affect any workflow or script behavior.
Changes:
- Adds a "One-time PR guidance comment" section to
pull-request-dashboard/README.mddescribing when the guidance comment is posted and how the hidden marker prevents repeats. - Deletes the duplicate
.github/scripts/pull-request-dashboard/README.md(its Configuration/State/Notes content already exists in the root README). - Minor note: the deleted README's "Manual targeted PR refresh" (
workflow_dispatchwithpr_number) example is the one detail not preserved in the surviving README, even though the workflow still supports thepr_numberinput.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
pull-request-dashboard/README.md |
Adds an accurate section documenting the one-time review-guidance comment behavior. |
.github/scripts/pull-request-dashboard/README.md |
Removes the duplicate implementation README; no remaining references, so the deletion is safe. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
maryliag
approved these changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the one-time guidance comment that the pull request dashboard posts after a submitted review includes inline comments, and remove the duplicate implementation README so the root pull-request-dashboard README is the single source of truth.