Skip to content

Fix formatting of contents section in overview.md#1646

Open
schalkventer wants to merge 1 commit into
TanStack:mainfrom
schalkventer:patch-2
Open

Fix formatting of contents section in overview.md#1646
schalkventer wants to merge 1 commit into
TanStack:mainfrom
schalkventer:patch-2

Conversation

@schalkventer

@schalkventer schalkventer commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

🎯 Changes

✅ Checklist

  • I have tested this code locally with pnpm test.

🚀 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
    • Updated the contents table of contents to use a plain dash separator in several links for clearer, more consistent display.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 587431b3-cf7c-4fbf-9a3c-2b2b48b75693

📥 Commits

Reviewing files that changed from the base of the PR and between 95e25bd and 1290575.

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

📝 Walkthrough

Walkthrough

The pull request updates docs/overview.md, replacing the — HTML entity with a plain dash character in the Contents table-of-contents entries for four links.

Changes

Documentation formatting update

Layer / File(s) Summary
TOC separator update
docs/overview.md
Changed the separator in four Contents links from the — HTML entity to a plain dash character.

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

Poem

A rabbit hopped through docs so neat,
Swapped an entity for a dash so sweet,
Four little links now read with ease,
No more mdash to hop and squeeze,
A tiny fix, a tidy feat! 🐇

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is just the template; it lacks an actual change summary, checklist status, and release-impact details. Replace the template placeholders with a brief change summary, mark the checklist items, and state whether this is docs-only or needs a changeset.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR's change: formatting the contents section in overview.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

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