docs: refactor README branding and positioning#85
Conversation
- Lead with single value proposition: "Predicts where your design will break" - Promote calibration as core differentiator (not a feature among many) - Reduce badges from 7 to 3 (npm, CI, Release) - Restructure: Why → Getting Started → What It Checks → Installation - Compress roadmap into Contributing section - Update category table to new 5-category structure (29 rules) - Primary entry point prominent, other channels in expandable section Closes #72 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe README was refocused: header and badges removed, tagline rewritten to claim predicting where Figma designs will break during AI implementation, rules condensed from 32/6 to 29/5, calibration elevated to a 6‑agent HTML→pixel-compare pipeline, and Getting Started/Installation reorganized with new "What It Checks" and contributing guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 68: The table's internal link to "Claude Code Skill" points to
`#claude-code-skill` but the content is inside a <details>/<summary> which doesn't
generate that anchor; update the doc so the anchor exists by adding an explicit
markdown heading or HTML anchor before the <details> block (e.g., add a "###
Claude Code Skill" or an <a id="claude-code-skill"></a> immediately above the
<details>), and ensure the table link text "Claude Code Skill" matches that
anchor exactly; modify the heading/anchor near the existing <details>/<summary>
block (the block containing the Claude Code Skill content) rather than changing
the table link.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 6f3909bc-833e-4e4f-acab-fe8f2707c340
📒 Files selected for processing (1)
README.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README.md (1)
68-68:⚠️ Potential issue | 🟡 MinorFix broken internal navigation link for "Claude Code Skill."
The table references "Claude Code Skill" but the corresponding section (lines 192-200) uses a
<details>/<summary>structure that doesn't generate the#claude-code-skillanchor on GitHub.📝 Suggested fix
Add an explicit anchor before the
<details>block at line 191:+<a id="claude-code-skill"></a> <details> <summary><strong>Claude Code Skill</strong> (lightweight, no MCP install)</summary>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 68, The "Claude Code Skill" table link points to the anchor "#claude-code-skill" but the current <details>/<summary> block for that section does not create that anchor; add an explicit HTML anchor element with id/name "claude-code-skill" immediately before the <details> block that contains the "Claude Code Skill" summary so the table link resolves correctly (i.e., insert an anchor with id="claude-code-skill" just above the details/summary for Claude Code Skill).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@README.md`:
- Line 68: The "Claude Code Skill" table link points to the anchor
"#claude-code-skill" but the current <details>/<summary> block for that section
does not create that anchor; add an explicit HTML anchor element with id/name
"claude-code-skill" immediately before the <details> block that contains the
"Claude Code Skill" summary so the table link resolves correctly (i.e., insert
an anchor with id="claude-code-skill" just above the details/summary for Claude
Code Skill).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 8cb3e0bf-6638-4f57-86af-19270a2e645c
📒 Files selected for processing (1)
README.md
Summary
#72 — README 브랜딩/포지셔닝 리팩터
Changes
Principles from issue
Closes #72
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit