Conversation
📝 WalkthroughWalkthroughDocumentation formatting adjusted in the installation guide by converting framework section headings from top-level (H1) to third-level (H3) format across two sections, with a final newline added to the file. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/installation.md (1)
26-70:⚠️ Potential issue | 🟡 MinorHeading hierarchy now skips a level (
h3without anh2).This triggers MD001 and weakens structure for TOC/screen-reader navigation. Add an
##section header before each group (framework install + devtools setup), then keep framework names at###.Also applies to: 92-116
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/installation.md` around lines 26 - 70, The document uses multiple H3 headings (e.g., "React", "Preact", "Solid", "Angular", "Vue", "Lit") with no enclosing H2, causing a skipped heading level; before each framework block that includes installation + devtools instructions add a parent H2 (for example "## Framework installation and devtools" or "## Installation by framework") and keep the existing framework names as H3, repeating this pattern for the later section group as well (the same fix applies to the other block referenced around "React"/"Preact"/"Solid" etc.).
🧹 Nitpick comments (1)
docs/installation.md (1)
92-116: Duplicate framework headings may produce ambiguous anchors.The second
### React/Preact/Solid/Vueset triggers MD024. Consider making these headings unique (e.g.,### React devtools) to avoid duplicate-heading and potential anchor collisions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/installation.md` around lines 92 - 116, The file contains repeated level-3 headings ("### React", "### Preact", "### Solid", "### Vue") that create duplicate anchors and trigger MD024; update the duplicate headings (for the repeated blocks that reference devtools) to unique names—e.g., rename the second occurrences to "### React devtools", "### Preact devtools", "### Solid devtools", and "### Vue devtools" (or another clear suffix) so each heading is unique; locate the duplicated heading tokens in the docs/installation.md diff and apply the renames to the heading text only, preserving the surrounding devtools links/comments.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/installation.md`:
- Around line 26-70: The document uses multiple H3 headings (e.g., "React",
"Preact", "Solid", "Angular", "Vue", "Lit") with no enclosing H2, causing a
skipped heading level; before each framework block that includes installation +
devtools instructions add a parent H2 (for example "## Framework installation
and devtools" or "## Installation by framework") and keep the existing framework
names as H3, repeating this pattern for the later section group as well (the
same fix applies to the other block referenced around "React"/"Preact"/"Solid"
etc.).
---
Nitpick comments:
In `@docs/installation.md`:
- Around line 92-116: The file contains repeated level-3 headings ("### React",
"### Preact", "### Solid", "### Vue") that create duplicate anchors and trigger
MD024; update the duplicate headings (for the repeated blocks that reference
devtools) to unique names—e.g., rename the second occurrences to "### React
devtools", "### Preact devtools", "### Solid devtools", and "### Vue devtools"
(or another clear suffix) so each heading is unique; locate the duplicated
heading tokens in the docs/installation.md diff and apply the renames to the
heading text only, preserving the surrounding devtools links/comments.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 3513ef2b-493d-4295-b42a-969d4c762467
📒 Files selected for processing (1)
docs/installation.md
🎯 Changes
Updates framework section headings in docs/installation.md from # to ### to fix the render
https://tanstack.com/hotkeys/latest/docs/installation


✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit