Skip to content

chore: update getting-started docs with new tools and features#32

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/update-getting-started
Jun 15, 2026
Merged

chore: update getting-started docs with new tools and features#32
shenxianpeng merged 1 commit into
mainfrom
chore/update-getting-started

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

Changes

Applied the same updates from the organization profile README to the documentation site:

🔧 Clang Tools — Simplified section:

  • clang-tools-static-binaries — updated description to include clang-include-cleaner (LLVM 18+)
  • clang-apply-replacements (new card) — standalone Python wheel
  • clang-include-cleaner (new card) — standalone Python wheel for detecting unused #include directives
  • Renamed section from "Clang Tools Distribution" to "Clang Tools — Simplified" for consistency with the profile README

📦 Easy Installation:

  • clang-tools-pip — updated description to mention both static binary and Python wheel installation for all five tools (clang-format, clang-tidy, clang-query, clang-apply-replacements, clang-include-cleaner)

📘 Repo README:

  • Minor update to the "What You'll Find" section to mention clang tools distribution guides

@netlify

netlify Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploy Preview for cpp-linter-github-io ready!

Name Link
🔨 Latest commit b531a30
🔍 Latest deploy log https://app.netlify.com/projects/cpp-linter-github-io/deploys/6a305a4c3d38e5000819f0dc
😎 Deploy Preview https://deploy-preview-32--cpp-linter-github-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Add clang-include-cleaner to clang-tools-static-binaries description (LLVM 18+)
- Add clang-apply-replacements and clang-include-cleaner standalone wheel cards
- Rename section to 'Clang Tools — Simplified' for consistency
- Update clang-tools-pip card to mention both binary and wheel support
@shenxianpeng shenxianpeng force-pushed the chore/update-getting-started branch from 0549980 to b531a30 Compare June 15, 2026 20:02
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jun 15, 2026
@shenxianpeng shenxianpeng merged commit 23f9095 into main Jun 15, 2026
7 checks passed
@shenxianpeng shenxianpeng deleted the chore/update-getting-started branch June 15, 2026 20:03
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.

1 participant