Skip to content

chore: revise profile readme#94

Merged
shenxianpeng merged 17 commits into
mainfrom
chore/update-profile-readme-2
Jul 8, 2026
Merged

chore: revise profile readme#94
shenxianpeng merged 17 commits into
mainfrom
chore/update-profile-readme-2

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 8, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Refreshed the project README with a more concise overview, updated badges, and a redesigned “Which one should I use?” section for easier package selection.
    • Removed example and extra package details from the top section to streamline the page.
  • Chores

    • Updated ignore rules to exclude local planning notes from version control.

- Replace promotional tagline with factual description
- Remove dramatic 'No more...' claims from intro section
- Rename 'Why cpp-linter?' to more neutral 'Why cpp-linter?'
- Tone down problem/solution comparison claims
- Remove rocket emoji, simplify section titles
- Make voice more grounded and factual throughout
- Revert to original badge style (compact, not for-the-badge)
- Restore original About / Quick example / More packages sections
- Remove platform badges row, 'Why cpp-linter?' comparison table
- Remove 'Powered by clang-tidy & clang-format' from footer
- Keep mermaid decision flow chart as the only new addition
- About精简为2句话,去掉冗余描述
- 去掉mermaid chart(节点不可点击,无法跳转仓库)
- 保留表格,所有项目名都是可点击的链接
- 表格首列改用平台 badge,更直观美观
- 'How' 列改为 'One-liner',更简洁
- 移除 Quick example 板块,让入口更聚焦
- Each 'Your goal' entry now fits on one line
- e.g. 'Lint & format PRs / pushes in CI' → 'CI/CD linting'
- e.g. 'Catch issues before you commit' → 'Pre-commit linting'
- e.g. 'Use containers / custom CI images' → 'Docker images'
- Remove 'New here?' tip (table is self-explanatory now)
- Wrap badge + title in <div align=center><br/> for consistent alignment
- Remove <div> wrapper that caused two-line layout
- Add style=vertical-align:middle so badge and title align on one line
- Your goal 列去掉 badge 图片,只保留粗体标题
- 表格更简洁,一列一意,不分散注意力
Updated the link for static binaries to point directly to the releases page.
Removed the main title from the README file.
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jul 8, 2026
@shenxianpeng shenxianpeng marked this pull request as ready for review July 8, 2026 17:52
@shenxianpeng shenxianpeng merged commit f25d6d7 into main Jul 8, 2026
5 of 6 checks passed
@shenxianpeng shenxianpeng deleted the chore/update-profile-readme-2 branch July 8, 2026 17:52
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6a5ece86-a840-4fed-86a5-4a62aae28e43

📥 Commits

Reviewing files that changed from the base of the PR and between b933e06 and d07280c.

📒 Files selected for processing (2)
  • .gitignore
  • profile/README.md

Walkthrough

This PR reformats the top of profile/README.md, replacing the banner/badge block, condensing the About section, and reworking the "Which one should I use?" table while removing the Quick example and More packages sections. Separately, .gitignore is updated to exclude PLAN.md.

Changes

Profile README restructuring

Layer / File(s) Summary
Banner and badges update
profile/README.md
Replaces the centered banner image and badge set with a smaller banner and updated Shields badges.
About and chooser table rewrite
profile/README.md
Condenses the About section text and reworks the "Which one should I use?" table columns/wording, removing the Quick example and More packages sections.

Gitignore update

Layer / File(s) Summary
Ignore local planning docs
.gitignore
Adds a comment and pattern to ignore PLAN.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • cpp-linter/.github#82: Overlaps with rewriting the same banner, About, and Which one should I use sections in profile/README.md.
  • cpp-linter/.github#92: Updates the same "Which one should I use?" chooser section table/labels introduced there.
  • cpp-linter/.github#89: Modifies the same package/installation table area of profile/README.md.

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.

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