Skip to content

Commit c730cd2

Browse files
committed
docs: tighten the copy on the new pages
- state the positioning as a plain sentence instead of a bold colon reveal - drop rhetorical setups, a metaphor kicker and mid-sentence bold - give inanimate subjects human-free verbs; active voice where it was passive
1 parent 38fc818 commit c730cd2

4 files changed

Lines changed: 26 additions & 28 deletions

File tree

‎docs/blog/posts/2026-09-12-moving-to-cpp-linter.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ authors:
1717
A common C++ workflow on GitHub has two lint jobs that grew up separately: a format check that
1818
fails the build, and a clang-tidy job that posts review comments. They pin different clang
1919
versions, they run on different triggers, and when one of them starts flaking nobody remembers why
20-
it was configured that way. This post walks through replacing both with one cpp-linter-action step,
21-
and what changes for contributors.
20+
it was configured that way. Both jobs can be one cpp-linter-action step.
2221

2322
<!-- more -->
2423

@@ -52,7 +51,7 @@ jobs:
5251
5352
The format job fails with a diff in the log; the tidy job builds a Docker image, runs, uploads an
5453
artifact, and a second workflow posts the review. Contributors see a red check for formatting and a
55-
review for clang-tidy, and format fixes still have to be made by hand.
54+
review for clang-tidy, and still fix the formatting by hand.
5655
5756
## The replacement
5857
@@ -108,14 +107,14 @@ every push instead of adding a new one.
108107

109108
## Adopting a strict `.clang-tidy` on an old code base
110109

111-
The usual reason teams keep clang-tidy out of pull requests is the first run: thousands of
112-
findings in files nobody is touching. Two inputs handle that:
110+
Teams usually keep clang-tidy out of pull requests because of the first run, which reports
111+
thousands of findings in files nobody is touching. Two inputs handle that:
113112

114113
- `files-changed-only: true` (the default) limits analysis to files in the pull request.
115114
- `lines-changed-only: true` limits reported clang-tidy findings to lines the pull request changed.
116115

117-
With both set, a pull request only hears about the code it wrote. The rest of the tree gets cleaned
118-
up gradually, or in a dedicated pass with the `cpp-linter` CLI.
116+
With both set, contributors only see findings on the lines they changed. You clean up the rest of
117+
the tree gradually, or in one pass with the `cpp-linter` CLI.
119118

120119
## What contributors see
121120

‎docs/blog/posts/2026-09-12-one-clang-version-everywhere.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ whatever clang happens to be around.
2626

2727
<!-- more -->
2828

29-
This is the problem the cpp-linter tools are built around: **pick one LLVM major version and use it
30-
in every place code gets checked**.
29+
The cpp-linter tools are built to pick one LLVM major version and use it in every place code gets
30+
checked.
3131

3232
## Pick the version once
3333

@@ -59,7 +59,7 @@ repos:
5959
```
6060
6161
`--style=file` and `--checks=.clang-tidy` read the same `.clang-format` and `.clang-tidy` files
62-
that CI will use, so there is one source of truth for the rules as well as for the version.
62+
that CI will use, so the rules, like the version, are defined in one place.
6363

6464
## CI: cpp-linter-action
6565

@@ -149,10 +149,10 @@ When LLVM 22 is the version you want:
149149
If the action reports differences at this point, the two tools are not on the same version, and
150150
the numbers above are the first thing to check.
151151

152-
## Why this matters more for clang-tidy
152+
## clang-tidy drifts more than clang-format
153153

154-
`clang-format` version drift produces noisy diffs. `clang-tidy` version drift produces *different
155-
findings*: checks that were added, renamed or made stricter. A pull request that passes locally and
156-
fails in CI with a check nobody has heard of is usually a version mismatch, not a code problem.
157-
Pinning the same major version in the hook and in the action turns "why does CI complain" into a
158-
deterministic question.
154+
`clang-format` version drift produces noisy diffs. `clang-tidy` version drift produces different
155+
findings: checks that were added, renamed or made stricter. A pull request that passes locally and
156+
fails in CI with a check nobody has heard of is usually a version mismatch. With the hook and the
157+
action pinned to the same major version, the two numbers to compare are `--version` in
158+
`.pre-commit-config.yaml` and `version` in the workflow.

‎docs/showcase.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description: Open-source projects that run cpp-linter-action and cpp-linter-hook
77

88
<!-- markdownlint-disable MD033 -->
99

10-
More than **550 public repositories** run [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)
11-
from a workflow on their default branch, with **over 87,000 GitHub stars** between them.
10+
More than 550 public repositories run [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)
11+
from a workflow on their default branch, with over 87,000 GitHub stars between them.
1212
The list below is the top of that set, ranked by stars.
1313

1414
!!! info "How this list is built"
@@ -65,7 +65,7 @@ shows the live list.
6565

6666
## Add your project
6767

68-
Using cpp-linter in a public project? Open a pull request against
68+
To add a public project, open a pull request against
6969
[cpp-linter.github.io](https://github.com/cpp-linter/cpp-linter.github.io/edit/main/docs/showcase.md)
7070
and add a row, or mention it in
71-
[GitHub Discussions](https://github.com/cpp-linter/cpp-linter/discussions) and we will add it for you.
71+
[GitHub Discussions](https://github.com/cpp-linter/cpp-linter/discussions) and we will add it.

‎docs/why-cpp-linter.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: How cpp-linter compares with other clang-format and clang-tidy GitH
66
# Why cpp-linter?
77

88
There are several ways to run `clang-format` and `clang-tidy` on a pull request. Most of them do
9-
one tool, in one place, with whatever clang version the runner happens to have. cpp-linter is built
10-
around a different idea: **one pinned LLVM version, both tools, every place code gets checked**,
11-
from a contributor's pre-commit hook to the review comments on the pull request.
9+
one tool, in one place, with whatever clang version the runner happens to have. cpp-linter pins one
10+
LLVM version and runs both tools in every place code gets checked, from a contributor's pre-commit
11+
hook to the review comments on the pull request.
1212

13-
## The short version
13+
## What you get
1414

1515
- **Both tools in one step.** `clang-format` and `clang-tidy` run from a single
1616
`cpp-linter/cpp-linter-action@v2` step. The other actions in the table below do one or the other.
@@ -52,10 +52,9 @@ links to verify a cell. ✓ yes · ✗ no · — not applicable.
5252

5353
<!-- markdownlint-enable MD013 MD033 -->
5454

55-
If you maintain one of these projects and a cell is out of date, please
56-
[open an issue](https://github.com/cpp-linter/cpp-linter.github.io/issues/new) or edit this page;
57-
we will correct it. The point of the table is to help people pick the right tool, not to rank
58-
projects.
55+
The table is there to help people pick a tool. If you maintain one of these projects and a cell is
56+
out of date, [open an issue](https://github.com/cpp-linter/cpp-linter.github.io/issues/new) or
57+
edit this page and we will correct it.
5958

6059
[reviewdog](https://github.com/reviewdog/reviewdog) is not in the table because it is a reporting
6160
framework rather than a linter: it has no built-in clang-format or clang-tidy support and needs a

0 commit comments

Comments
 (0)