diff --git a/README.md b/README.md index 1d200f4c..0b04b302 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,16 @@ [pr-review]: https://cpp-linter.github.io/cpp-linter-rs/cli#-p-pr-review [other-licenses]: https://cpp-linter.github.io/cpp-linter-rs/other-licenses -[format-annotations-preview]: docs/docs/images/annotations-clang-format.png -[tidy-annotations-preview]: docs/docs/images/annotations-clang-tidy.png -[step-summary-preview]: docs/docs/images/step-summary.png -[thread-comment-preview]: docs/docs/images/comment.png -[tidy-review-preview]: docs/docs/images/tidy-review.png -[format-review-preview]: docs/docs/images/format-review.png -[format-suggestion-preview]: docs/docs/images/format-suggestion.png +[annotations-diff-light]: docs/docs/images/annotations-diff-light.png#gh-light-mode-only +[annotations-diff-dark]: docs/docs/images/annotations-diff-dark.png#gh-dark-mode-only +[annotations-summary-light]: docs/docs/images/annotations-summary-light.png#gh-light-mode-only +[annotations-summary-dark]: docs/docs/images/annotations-summary-dark.png#gh-dark-mode-only +[thread-comment-light]: docs/docs/images/thread-comment-light.png#gh-light-mode-only +[thread-comment-dark]: docs/docs/images/thread-comment-dark.png#gh-dark-mode-only +[pr-review-light]: docs/docs/images/pr-review-light.png#gh-light-mode-only +[pr-review-dark]: docs/docs/images/pr-review-dark.png#gh-dark-mode-only +[step-summary-light]: docs/docs/images/step-summary-light.png#gh-light-mode-only +[step-summary-dark]: docs/docs/images/step-summary-dark.png#gh-dark-mode-only [cli-doc]: https://cpp-linter.github.io/cpp-linter-rs/cli @@ -103,39 +106,36 @@ For the description of supported Command Line Interface options, see Using [`--file-annotations`][file-annotations]: -#### clang-format annotations +#### In the pull request's changed files -![clang-format annotations][format-annotations-preview] +![clang-tidy annotation][annotations-diff-light] +![clang-tidy annotation][annotations-diff-dark] -#### clang-tidy annotations +#### In the workflow run summary -![clang-tidy annotations][tidy-annotations-preview] +![annotations in the workflow run summary][annotations-summary-light] +![annotations in the workflow run summary][annotations-summary-dark] ### Thread Comment Using [`--thread-comments`][thread-comments]: -![sample thread-comment][thread-comment-preview] +![sample thread-comment][thread-comment-light] +![sample thread-comment][thread-comment-dark] ### Step Summary Using [`--step-summary`][step-summary]: -![step summary][step-summary-preview] +![step summary][step-summary-light] +![step summary][step-summary-dark] ### Pull Request Review Using [`--pr-review`][pr-review]: -#### Only clang-tidy - -![sample tidy-review][tidy-review-preview] - -#### Only clang-format - -![sample format-review][format-review-preview] - -![sample format-suggestion][format-suggestion-preview] +![sample pr-review][pr-review-light] +![sample pr-review][pr-review-dark] ## Sponsors diff --git a/docs/docs/images/annotations-clang-format.png b/docs/docs/images/annotations-clang-format.png deleted file mode 100644 index 2175c94b..00000000 Binary files a/docs/docs/images/annotations-clang-format.png and /dev/null differ diff --git a/docs/docs/images/annotations-clang-tidy.png b/docs/docs/images/annotations-clang-tidy.png deleted file mode 100644 index 1ac02e6c..00000000 Binary files a/docs/docs/images/annotations-clang-tidy.png and /dev/null differ diff --git a/docs/docs/images/annotations-diff-dark.png b/docs/docs/images/annotations-diff-dark.png new file mode 100644 index 00000000..a3c88cd8 Binary files /dev/null and b/docs/docs/images/annotations-diff-dark.png differ diff --git a/docs/docs/images/annotations-diff-light.png b/docs/docs/images/annotations-diff-light.png new file mode 100644 index 00000000..bd74413f Binary files /dev/null and b/docs/docs/images/annotations-diff-light.png differ diff --git a/docs/docs/images/annotations-summary-dark.png b/docs/docs/images/annotations-summary-dark.png new file mode 100644 index 00000000..e57f3bbf Binary files /dev/null and b/docs/docs/images/annotations-summary-dark.png differ diff --git a/docs/docs/images/annotations-summary-light.png b/docs/docs/images/annotations-summary-light.png new file mode 100644 index 00000000..0ff11639 Binary files /dev/null and b/docs/docs/images/annotations-summary-light.png differ diff --git a/docs/docs/images/comment.png b/docs/docs/images/comment.png deleted file mode 100644 index 2c41fcd7..00000000 Binary files a/docs/docs/images/comment.png and /dev/null differ diff --git a/docs/docs/images/format-review.png b/docs/docs/images/format-review.png deleted file mode 100644 index 30be6b30..00000000 Binary files a/docs/docs/images/format-review.png and /dev/null differ diff --git a/docs/docs/images/format-suggestion.png b/docs/docs/images/format-suggestion.png deleted file mode 100644 index 02168619..00000000 Binary files a/docs/docs/images/format-suggestion.png and /dev/null differ diff --git a/docs/docs/images/pr-review-dark.png b/docs/docs/images/pr-review-dark.png new file mode 100644 index 00000000..674eae81 Binary files /dev/null and b/docs/docs/images/pr-review-dark.png differ diff --git a/docs/docs/images/pr-review-light.png b/docs/docs/images/pr-review-light.png new file mode 100644 index 00000000..e6e6068b Binary files /dev/null and b/docs/docs/images/pr-review-light.png differ diff --git a/docs/docs/images/step-summary-dark.png b/docs/docs/images/step-summary-dark.png new file mode 100644 index 00000000..ddff59c7 Binary files /dev/null and b/docs/docs/images/step-summary-dark.png differ diff --git a/docs/docs/images/step-summary-light.png b/docs/docs/images/step-summary-light.png new file mode 100644 index 00000000..ada7b8bc Binary files /dev/null and b/docs/docs/images/step-summary-light.png differ diff --git a/docs/docs/images/step-summary.png b/docs/docs/images/step-summary.png deleted file mode 100644 index f23e68d4..00000000 Binary files a/docs/docs/images/step-summary.png and /dev/null differ diff --git a/docs/docs/images/thread-comment-dark.png b/docs/docs/images/thread-comment-dark.png new file mode 100644 index 00000000..880136e3 Binary files /dev/null and b/docs/docs/images/thread-comment-dark.png differ diff --git a/docs/docs/images/thread-comment-light.png b/docs/docs/images/thread-comment-light.png new file mode 100644 index 00000000..3ad2730d Binary files /dev/null and b/docs/docs/images/thread-comment-light.png differ diff --git a/docs/docs/images/tidy-review.png b/docs/docs/images/tidy-review.png deleted file mode 100644 index 8b58a41d..00000000 Binary files a/docs/docs/images/tidy-review.png and /dev/null differ diff --git a/docs/docs/index.md b/docs/docs/index.md index f431ea03..1dad16dd 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -6,13 +6,16 @@ [pr-review]: cli.md#-p-pr-review [other-licenses]: other-licenses.md -[format-annotations-preview]: images/annotations-clang-format.png -[tidy-annotations-preview]: images/annotations-clang-tidy.png -[step-summary-preview]: images/step-summary.png -[thread-comment-preview]: images/comment.png -[tidy-review-preview]: images/tidy-review.png -[format-review-preview]: images/format-review.png -[format-suggestion-preview]: images/format-suggestion.png +[annotations-diff-light]: images/annotations-diff-light.png#gh-light-mode-only +[annotations-diff-dark]: images/annotations-diff-dark.png#gh-dark-mode-only +[annotations-summary-light]: images/annotations-summary-light.png#gh-light-mode-only +[annotations-summary-dark]: images/annotations-summary-dark.png#gh-dark-mode-only +[thread-comment-light]: images/thread-comment-light.png#gh-light-mode-only +[thread-comment-dark]: images/thread-comment-dark.png#gh-dark-mode-only +[pr-review-light]: images/pr-review-light.png#gh-light-mode-only +[pr-review-dark]: images/pr-review-dark.png#gh-dark-mode-only +[step-summary-light]: images/step-summary-light.png#gh-light-mode-only +[step-summary-dark]: images/step-summary-dark.png#gh-dark-mode-only [cli-doc]: cli.md