docs: rework the READMEs to the org layout and fix the install commands

[shenxianpeng]

Part of aligning the READMEs across the org (same layout as cpp-linter/cpp-linter-hooks#289). Every install command was run today.

Install commands

Command	Today	Now
cargo install cpp-linter --features bin	fails: no version matches *. Any range picks 2.0.0-rc9 (semver sorts it after rc.23), which has no bin feature	--version 2.0.0-rc.23
cargo binstall cpp-linter	fails the same way	--version 2.0.0-rc.23
pip install cpp-linter	installs the Python package 1.14.1	the README says so; TestPyPI needs --pre (fails without it on pip 26.2.1 and 25.2)
npm install @cpp-linter/cpp-linter	fails: latest is the deprecated rc2	@cpp-linter/cpp-linter@next (rc.21)

The rc.23 pin has to be bumped by hand at each crate release, since bump-n-release.nu does not touch READMEs.

README.md

• Header:
  • The H1 is cpp-linter-rs.
  • Badges: v2 release candidate, ci (run-dev-tests.yml), coverage, part of cpp-linter. The five build badges are gone.
  • The checklist becomes one sentence with the same words and links.
  • A link line follows.
• Warning: the website's wording, "in release candidates; use the Python package until 2.0 is released", instead of "experimental".
• Badges further down:
  • TestPyPI and npm next stay, in the same colors.
  • crates.io, PyPI and docs.rs are gone; they showed rc9, 1.14.1 or the wrong version.
• Example: it used the removed --tidy-review/--format-review links. It now uses --pr-review (deprecate: replace --tidy-review/--format-review with --pr-review #377), and all 7 images load.
• Sections: ## Install becomes ## Quick start, with the content unchanged. "Have question or feedback?" becomes ## Contributing and links CONTRIBUTING.md.

Package READMEs

• All three: a link line is added, and the cli.html links (404) now point to /cli/.
• cpp-linter/README.md (crates.io): typos and "Github" spellings are fixed. The CHANGELOG badge is removed; restore it if you want it on crates.io.
• bindings/python/README.md: the TestPyPI command gets --pre, and cpp-linter -help becomes --help.
• bindings/node/README.md: the install command uses @next.

docs/docs/index.md

The [tidy-review] and [format-review] definitions become [pr-review]. Without this the docs home page would print [--pr-review][pr-review] as text.

Checked

• readme_renderer passes for the Python binding README.
• pre-commit, including cspell, passes.
• All links return 200 (npmjs.com answers scripts with 403).
• The docs build runs on this PR.

Outside this PR

• npm latest: it still points to the deprecated rc2. An npm owner can run npm dist-tag add @cpp-linter/cpp-linter@2.0.0-rc.21 latest.
• crates.io: it shows rc9's README until 2.0 is out, or until rc1 to rc15 are yanked. Yanking would also let a version range pick the newest rc.

Summary by CodeRabbit

• Documentation
  • Updated project and package guides with links to the website, documentation, getting-started resources, and discussions.
  • Added v2 release-candidate quick-start instructions for Rust, npm, and Python, including pre-release installation details and a note about the current PyPI package.
  • Updated pull-request review guidance to use --pr-review and refreshed CLI documentation links.
  • Revised package badges and descriptions.

[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: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Advanced

Run ID: 1f51b424-b0a6-4903-af9c-446d01212909

📥 Commits

Reviewing files that changed from the base of the PR and between 699fa40 and f6abc2a.

📒 Files selected for processing (3)

• README.md
• bindings/node/README.md
• bindings/python/README.md

🚧 Files skipped from review as they are similar to previous changes (2)

• bindings/python/README.md
• bindings/node/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

Walkthrough

The README files update v2 release-candidate installation guidance, package availability notes, and project links. The main README and documentation index replace references to separate tidy and format review options with the unified --pr-review option.

Changes

Release-candidate documentation

Layer / File(s)	Summary
Release and package quick starts README.md, bindings/node/README.md, bindings/python/README.md, cpp-linter/README.md	The READMEs update project links, package availability notes, installation commands, package badges, and CLI documentation links for the v2 release-candidate period.
Unified pull-request review documentation README.md, docs/docs/index.md	The main README replaces separate tidy and format review examples with a --pr-review example and adds contribution links. The documentation index links to the unified option.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to f6abc

The updated installation and review-option guidance matches the repository’s local configuration. No concrete regression from these documentation changes warrants holding the PR.

Architecture Summary

Architecture risk: 🔵 Low · up to f6abc

The change affects 4 systems.

Changed systems: bindings, cpp-linter, docs, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — bindings (service) was modified; 2 changed files map to changed impact.
• observed — cpp-linter (service) was modified; 1 changed file maps to changed impact.
• observed — docs (service) was modified; 1 changed file maps to changed impact.
• observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in cpp-linter/README.md: The README revises the crate description and GitHub feature wording, adds links to the website, documentation, getting-started guide, and discussions, and updates the CLI link from cli.html to cli/. The crates.io, docs.rs, and changelog badges and their reference links are removed.
• observed — Modified behavior in docs/docs/index.md: Added the [pr-review] reference to cli.md#-p-pr-review, replacing the [tidy-review] and [format-review] references.
• observed — Modified behavior in README.md: Adds the pr-review CLI documentation link and removes the links for the separate tidy-review and format-review options.
• observed — Modified behavior in README.md: Replaces the general C/C++ package overview and experimental-status warning with a v2 release-candidate introduction, updated project links, and a warning to use the pure-Python package until 2.0 is released.

🚥 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 main changes: reworking the READMEs and updating installation commands.
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.

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

Autopilot is currently an internal CodeRabbit preview.

---

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.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.74%. Comparing base (a57e1ed) to head (f6abc2a).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #464   +/-   ##
=======================================
  Coverage   92.74%   92.74%           
=======================================
  Files          23       23           
  Lines        3859     3859           
=======================================
  Hits         3579     3579           
  Misses        280      280           

☔ 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.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[2bndy5]

Suggested change

	See also the [CLI document hosted on GitHub][gh-pages].
	[gh-pages]: https://cpp-linter.github.io/cpp-linter-rs/cli.html
	[crates-io-badge]: https://img.shields.io/crates/v/cpp-linter
	[crates-io-link]: https://crates.io/crates/cpp-linter
	[docs-badge]: https://img.shields.io/docsrs/cpp-linter
	[docs-link]: https://docs.rs/cpp-linter
	[changelog-badge]: https://img.shields.io/badge/keep_a_change_log-v1.1.0-ffec3d
	[changelog-link]: https://github.com/cpp-linter/cpp-linter-rs/blob/main/cpp-linter/CHANGELOG.md
	[gh-pages]: https://cpp-linter.github.io/cpp-linter-rs/cli/
	See also the [CLI document hosted on GitHub][cli-doc].
	[cli-doc]: https://cpp-linter.github.io/cpp-linter-rs/cli/

[shenxianpeng]

For this suggestion, I can not apply them successfully