Skip to content

fix: installation markdown docs#107

Open
ReverseGem7 wants to merge 1 commit intoTanStack:mainfrom
ReverseGem7:fix-installation-docs-markdown
Open

fix: installation markdown docs#107
ReverseGem7 wants to merge 1 commit intoTanStack:mainfrom
ReverseGem7:fix-installation-docs-markdown

Conversation

@ReverseGem7
Copy link
Copy Markdown

@ReverseGem7 ReverseGem7 commented Apr 12, 2026

🎯 Changes

Updates framework section headings in docs/installation.md from # to ### to fix the render

https://tanstack.com/hotkeys/latest/docs/installation
image
image

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Adjusted installation guide section structure for improved consistency and formatting.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 12, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation Formatting
docs/installation.md
Converted 6 framework headings (React, Preact, Solid, Angular, Vue, Lit) from H1 to H3 level in the main install and devtools sections; added end-of-file newline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 The docs reorganized with care so fine,
H1s became H3s, all in a line,
Frameworks nested neat, a visual delight,
One newline added, now the format's right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: installation markdown docs' clearly and concisely describes the main change: fixing markdown heading levels in installation documentation.
Description check ✅ Passed The PR description follows the template structure with all required sections filled out, including Changes, Checklist, and Release Impact sections with appropriate selections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟡 Minor

Heading hierarchy now skips a level (h3 without an h2).

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/Vue set 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

📥 Commits

Reviewing files that changed from the base of the PR and between 9041e8f and ce5bc90.

📒 Files selected for processing (1)
  • docs/installation.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant