Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Binary file removed docs/docs/images/annotations-clang-format.png
Binary file not shown.
Binary file removed docs/docs/images/annotations-clang-tidy.png
Binary file not shown.
Binary file added docs/docs/images/annotations-diff-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/annotations-diff-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/annotations-summary-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/annotations-summary-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/images/comment.png
Binary file not shown.
Binary file removed docs/docs/images/format-review.png
Binary file not shown.
Binary file removed docs/docs/images/format-suggestion.png
Binary file not shown.
Binary file added docs/docs/images/pr-review-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/pr-review-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/step-summary-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/step-summary-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/images/step-summary.png
Binary file not shown.
Binary file added docs/docs/images/thread-comment-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/thread-comment-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/images/tidy-review.png
Binary file not shown.
17 changes: 10 additions & 7 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading