docs: fix the quick start, the clang-tidy examples and Used By

[shenxianpeng]

Checked on 2026-09-26 with pre-commit 4.6 and rev: v1.6.0 in a scratch repository.

Quick start. Copied as written, the clang-tidy hook fails. YAML splits [--checks='boost-*,bugprone-*,...'] at the commas, so clang-tidy gets bugprone-* and the rest as file names: Could not auto-detect compilation database for file "bugprone-*", then Error: no checks enabled. Quoting the whole argument fixes it; with the new snippet the hook runs the listed checks.

--checks=.clang-tidy. The hook passes --checks to clang-tidy unchanged, and clang-tidy takes the value as a check glob. With clang-tidy 22.1.0 and a .clang-tidy of -*,readability-braces-around-statements, --list-checks prints the same checks with and without the flag, and --dump-config shows .clang-tidy appended to Checks. clang-tidy finds .clang-tidy by itself, so the flag is dropped from all ten examples.

Used By.

• Bosch Research: the only hits are boschresearch/smc_storm and smc_verifiable_plugins, 0-star forks of convince-project repositories (CONVINCE is already listed). None of the 133 non-fork boschresearch repositories uses the hook.
• Jupyter Xeus: jupyter-xeus/cpp-terminal has the hook commented out (.pre-commit-config.yaml L76-79).
• Rancher Sandbox: rancher-sandbox/runtime-enforcer now redirects to kubewarden/runtime-enforcer.
• Added, each with an active entry on its default branch: doldecomp (doldecomp/melee), HKUST Aerial Robotics (D2SLAM) and Kubewarden (runtime-enforcer). The other six entries still hold.

The last line now points to the showcase, since the hub has no full list of organizations.

Summary by CodeRabbit

• Documentation
  • Updated README examples to show clang-tidy options as YAML lists and clarify compilation-database detection, selection, and verbose output.
  • Refreshed the projects listed in “Used By” and linked to the cpp-linter showcase.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (690ec78) to head (841a488).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #285   +/-   ##
=======================================
  Coverage   97.53%   97.53%           
=======================================
  Files           3        3           
  Lines         243      243           
=======================================
  Hits          237      237           
  Misses          6        6           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 2e02354a-df75-4aef-bb19-6df9e5bd4478

📥 Commits

Reviewing files that changed from the base of the PR and between 690ec78 and 841a488.

📒 Files selected for processing (1)

• README.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.

---

Walkthrough

The README updates clang-tidy command examples, including compilation-database options. It also revises the Used By project list and changes the destination of the projects link.

Changes

README updates

Layer / File(s)	Summary
Clang-tidy usage examples README.md	The examples use a YAML list for checks and remove explicit --checks=.clang-tidy arguments. The compilation-database examples clarify auto-detection and show explicit selection, disabled detection, and verbose output.
Used By projects and link README.md	The list replaces Bosch Research, Jupyter Xeus, and Rancher Sandbox with doldecomp, HKUST Aerial Robotics, and Kubewarden. The projects link points to the cpp-linter showcase.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Merge Risk: ⚪ Minimal · up to 841a4

No specific behavior or documentation issue requiring resolution before merge is established by the supplied review context.

Architecture Summary

Architecture risk: 🔵 Low · up to 841a4

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in README.md: The clang-tidy example changes the checks argument from a quoted scalar to a YAML list value.
• observed — Modified behavior in README.md: The custom-configuration example removes the explicit --checks=.clang-tidy argument and notes that clang-tidy reads the configuration file itself.
• observed — Modified behavior in README.md: The version-pinning example removes --checks=.clang-tidy, retaining only --version=21.
• observed — Modified behavior in README.md: The compilation-database examples now show auto-detection as a comment and remove --checks=.clang-tidy from the auto-detect, explicit-directory, disabled-detection, and verbose configurations.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the documentation changes to the quick start, clang-tidy examples, and Used By section. It is concise and specific.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

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

_{Comment @coderabbitai help to get the list of available commands.}