Skip to content

docs: expand clang-tools-manager/README#366

Merged
2bndy5 merged 1 commit into
mainfrom
clang-tools-readme
Jun 15, 2026
Merged

docs: expand clang-tools-manager/README#366
2bndy5 merged 1 commit into
mainfrom
clang-tools-readme

Conversation

@2bndy5

@2bndy5 2bndy5 commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

resolves #351

  • adds badges
  • adds simple CLI info (with example and copied --help output)

Summary by CodeRabbit

  • Documentation
    • Expanded README documentation with comprehensive usage guide, including multiple installation methods (cargo install with bin feature, cargo-binstall, and pre-built binaries) and detailed CLI options reference
    • Updated project badges across documentation to include crates.io, docs.rs, and changelog references
    • Enhanced documentation structure with proper reference link definitions

resolves #351

- adds badges
- adds simple CLI info (with example and copied `--help` output)
@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Jun 15, 2026
@codecov

codecov Bot commented Jun 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.84%. Comparing base (9c54ee6) to head (1c286d7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #366   +/-   ##
=======================================
  Coverage   92.84%   92.84%           
=======================================
  Files          23       23           
  Lines        3464     3464           
=======================================
  Hits         3216     3216           
  Misses        248      248           

☔ 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 2bndy5 marked this pull request as ready for review June 15, 2026 10:27
@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bb258d02-41f2-4ff9-b6f8-c8d71f8e419a

📥 Commits

Reviewing files that changed from the base of the PR and between 790bc1d and 1c286d7.

📒 Files selected for processing (2)
  • clang-tools-manager/README.md
  • cpp-linter/README.md

Walkthrough

Two README files are updated. clang-tools-manager/README.md is expanded from a minimal description into a full usage document with crates.io/changelog badges, cargo install and cargo-binstall instructions, git checkout guidance, and a rendered clang-tools --help CLI reference. cpp-linter/README.md replaces its badge block with crates.io, docs.rs, and CHANGELOG badges and updates reference link definitions.

Changes

README Documentation Updates

Layer / File(s) Summary
clang-tools-manager README: badges, install, and CLI docs
clang-tools-manager/README.md
Adds crates.io and changelog badges, expands introductory text, documents cargo install (with --features bin) and cargo-binstall install paths, includes a "run from git clone" section, and adds a CLI section with the full clang-tools --help output and an example install command. Reference link definitions for badges are added at the bottom.
cpp-linter README: badge replacement and reference links
cpp-linter/README.md
Replaces the existing badge block with crates.io, docs.rs, and CHANGELOG badges, adds corresponding reference link definitions, and removes the obsolete [pypi-org] reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • cpp-linter/cpp-linter-rs#337: Modifies the same clang-tools-manager/README.md as part of the clang-installerclang-tools-manager rename, making it a direct predecessor to this README expansion.
🚥 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 change: expanding the clang-tools-manager README documentation with badges and CLI information.
Linked Issues check ✅ Passed The pull request addresses issue #351 by expanding the README with installation instructions (cargo-binstall and cargo install) and CLI documentation with help output.
Out of Scope Changes check ✅ Passed All changes are in-scope: clang-tools-manager README expanded with documentation, and cpp-linter README updated with matching badge styles.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch clang-tools-readme

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@2bndy5 2bndy5 merged commit 0b3167b into main Jun 15, 2026
23 checks passed
@2bndy5 2bndy5 deleted the clang-tools-readme branch June 15, 2026 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

revise the clang-tools-manager/README for better comprehension

1 participant