[shenxianpeng]

Resolves #559.

The README previews were screenshots of cpp-linter v1. This replaces them with screenshots of a real v2 run, each in a light and a dark variant.

What changed

• Thread comment: the v2 report, with the clang-format section expanded to show the per-file line count.

• PR review: one review with two comments, as suggested in Update preview pictures in README #559:

  1. a suggestion with clang-tidy's rationale (the suggestion also carries a clang-format fix on the same line),
  2. a clang-tidy rationale without a suggestion.

  The separate "Only clang-tidy" / "Only clang-format" sections are gone.

• Annotations: one screenshot of an annotation in the PR's changed files, and one of the annotations list in the workflow run summary. v2's clang-format notice has no line number, so GitHub shows it in the run summary only, not in the diff. That's why the old "clang-format annotations" / "clang-tidy annotations" split no longer fits.

• Step summary: the light and dark screenshots 2bndy5 took of the same run (GitHub only shows job summaries to signed-in users).

Light/dark switching uses the #gh-light-mode-only / #gh-dark-mode-only fragments. GitHub supports them, and so does Material for MkDocs (it follows the docs site's palette toggle), so the same reference links work in README.md and in docs/docs/index.md, which includes it. I checked both: the README on this branch on github.com, and a local mkdocs build, show only the matching image in each theme.

How the screenshots were made

They come from cpp-linter/test-cpp-linter-action#70 (a temporary PR, to be closed): cpp-linter v2.0.0-rc.25 on ubuntu-24.04 with clang 21.1.8, the repo's .clang-tidy (--tidy-checks=""), and --thread-comments=update --pr-review=true --file-annotations=true --step-summary=true. They were captured with Playwright at 2x scale and reduced to 256 colors (about 14–93 KB each).

Summary by CodeRabbit

• Documentation
  • Updated README and documentation imagery with light- and dark-mode examples for annotations, annotation summaries, thread comments, pull request reviews, and step summaries.
  • Revised annotation examples to show annotations in changed files and workflow run summaries.

[coderabbitai]

No actionable comments were generated in the recent review.

Walkthrough

The README and documentation index replace preview images with light- and dark-mode examples for annotations, thread comments, pull request reviews, and step summaries.

Changes: Documentation preview updates

Layer / File(s)	Summary
Update preview image references and examples README.md, docs/docs/index.md	The README and documentation index replace preview image references. The README examples show annotations in changed files and the workflow run summary, and use light- and dark-mode images for comments, step summaries, and pull request reviews.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Severity of issue fixed: Low

Merge Risk: Minimal · up to 81116

The refreshed previews have no identified merge-blocking issue.

Pre-merge checks: 3 · 1

Failed checks: 1 inconclusive

Check name	Status	Explanation	Resolution
Linked Issues check		Issue #559 requires v2 screenshots with detailed thread-comment output, the specified two-comment PR review, and light and dark variants. The PR description and Markdown change summary report these up…	Reviewable evidence of the excluded screenshot contents and variants is needed to confirm the requirements in issue #559.

Passed checks: 3 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly summarizes the documentation change: updating previews with v2 output in light and dark themes.
Out of Scope Changes check		The reported changes update README and documentation preview references. The listed image paths are preview assets for thread comments, reviews, annotations, and step summaries. No unrelated change is…

Full details: Out of Scope Changes check

Explanation

The reported changes update README and documentation preview references. The listed image paths are preview assets for thread comments, reviews, annotations, and step summaries. No unrelated change is established by the available evidence.

Full details: Linked Issues check

Explanation

Issue #559 requires v2 screenshots with detailed thread-comment output, the specified two-comment PR review, and light and dark variants. The PR description and Markdown change summary report these updates, but the screenshot files are excluded by !**/*.png. Their contents and whether each variant meets the requirements cannot be verified from the available evidence.

Resolution

Reviewable evidence of the excluded screenshot contents and variants is needed to confirm the requirements in issue #559.

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Repository UI (base), Organization UI (inherited)
• Review profile: CHILL
• Plan: Advanced
• Run ID: 802ab9fa-077f-4cf3-a164-d3eaaf744a9b

Commits

Reviewing files that changed from the base of the PR and between ecb3fad and 811160d.

Files ignored due to path filters: 17

• docs/docs/images/annotations-clang-format.png is excluded by !**/*.png
• docs/docs/images/annotations-clang-tidy.png is excluded by !**/*.png
• docs/docs/images/annotations-diff-dark.png is excluded by !**/*.png
• docs/docs/images/annotations-diff-light.png is excluded by !**/*.png
• docs/docs/images/annotations-summary-dark.png is excluded by !**/*.png
• docs/docs/images/annotations-summary-light.png is excluded by !**/*.png
• docs/docs/images/comment.png is excluded by !**/*.png
• docs/docs/images/format-review.png is excluded by !**/*.png
• docs/docs/images/format-suggestion.png is excluded by !**/*.png
• docs/docs/images/pr-review-dark.png is excluded by !**/*.png
• docs/docs/images/pr-review-light.png is excluded by !**/*.png
• docs/docs/images/step-summary-dark.png is excluded by !**/*.png
• docs/docs/images/step-summary-light.png is excluded by !**/*.png
• docs/docs/images/step-summary.png is excluded by !**/*.png
• docs/docs/images/thread-comment-dark.png is excluded by !**/*.png
• docs/docs/images/thread-comment-light.png is excluded by !**/*.png
• docs/docs/images/tidy-review.png is excluded by !**/*.png

Files selected for processing: 2

• README.md
• docs/docs/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

[2bndy5]

Made some screen grans of the step summary:

[shenxianpeng]

Thanks! Added both in 811160d as step-summary-light.png / step-summary-dark.png (replacing the old step-summary.png), switched the same way as the other previews.

---

Generated by Claude Code