docs(profile): refresh README with a chooser table and usage example#92
Merged
Conversation
Add an orientation table that maps common workflows (CI, local pre-commit, cross-platform CLI, macOS, polyglot teams, containers, raw binaries) to the right entry point, so users can pick a channel without reading every section. Also fixes the asdf shorthand hint.
WalkthroughA new "🧭 Which one should I use?" section was added to profile/README.md, providing a guidance table that maps reader goals to installation/integration options (GitHub Action, pre-commit hooks, pip CLI, Homebrew, asdf, Docker/CI images, static binaries), along with a "New here?" note. ChangesREADME onboarding guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@profile/README.md`:
- Line 37: The asdf chooser row still contains a placeholder instead of a
runnable command, so update the table entry in README to use the actual plugin
source URL rather than <url>. Locate the row with the asdf command text and
replace the placeholder in the asdf plugin add command so it can be copy/pasted
and executed as written.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
The asdf row in the "Which one should I use?" table used a <url> placeholder, so the command was not copy/paste-runnable. Replace it with the real plugin source URL.
Merge the overlapping "Get Started", "Clang Tools" and "Easy Installation" sections into a single "All projects" reference table so each repo is described once. Keep the chooser table as the primary "by goal" navigation, add a minimal cpp-linter-action usage example, and note LLVM/platform coverage in the About blurb.
Drop the flat "All projects" table that re-listed the same repos as the chooser (~70% overlap). Keep the chooser as the only primary navigation and the quick example, and move the lower-level/specialized packages into a collapsed "More packages" section so the front page leads with the handful of entry points most people actually need.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes the organization profile README so the front page leads with the handful of entry points most people actually need, instead of several overlapping install sections.
Changes
cpp-linter-actionworkflow so newcomers see it working without leaving the page.Notes
Scope is limited to the profile README. No changes to workflows or other repos.
🤖 Generated with Claude Code