Skip to content

Clean doc - #1

Merged
burisu merged 1 commit into
mainfrom
clean-doc
Mar 6, 2026
Merged

burisu merged 1 commit into
mainfrom
clean-doc

Conversation

@burisu

@burisu burisu commented Mar 6, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@burisu
burisu marked this pull request as ready for review March 6, 2026 10:31
@burisu
burisu requested a review from Copilot March 6, 2026 10:31
@github-actions

github-actions Bot commented Mar 6, 2026

Copy link
Copy Markdown

🏷️ [bumpr]
Next version:v0.1.0

@burisu
burisu merged commit c2c1846 into main Mar 6, 2026
10 checks passed
@burisu
burisu deleted the clean-doc branch March 6, 2026 10:32
@github-actions

github-actions Bot commented Mar 6, 2026

Copy link
Copy Markdown

🚀 [bumpr] Bumped!
New version:v0.1.0

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Cleans up the README by fixing the top-level heading formatting/wording and removing an outdated screenshot reference from the github-pr-review example section.

Changes:

  • Fix README H1 formatting and rename “yarn-audit” to "yarn audit" in the title.
  • Remove the embedded screenshot and simplify the github-pr-review example text.
  • Remove the now-unused screenshot asset.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Cleans up the header and removes the screenshot reference from the github-pr-review example section.
.github/images/example-github-pr-review.png Removes an unused screenshot asset that’s no longer referenced.

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

Comment thread README.md
With `reporter: github-pr-review` a comment is added to the Pull Request Conversation:

![Example comment made by the action, with github-pr-review](/.github/images/example-github-pr-review.png)
With `reporter: github-pr-review` a comment is added to the Pull Request Conversation.

Copilot AI Mar 6, 2026

Copy link

Choose a reason for hiding this comment

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

Minor grammar: add a comma after the introductory clause so the sentence reads more naturally (e.g., after github-pr-review).

Suggested change
With `reporter: github-pr-review` a comment is added to the Pull Request Conversation.
With `reporter: github-pr-review`, a comment is added to the Pull Request Conversation.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants