Skip to content

docs: fix malformed code fence in docs-info guide#837

Open
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/fix-docs-info-code-fence-clean
Open

docs: fix malformed code fence in docs-info guide#837
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/fix-docs-info-code-fence-clean

Conversation

@pavan-sh
Copy link
Copy Markdown
Contributor

@pavan-sh pavan-sh commented Apr 20, 2026

Fixes a malformed markdown code fence in docs-info.md (Maintainer Documentation Guide, Code Blocks section) by removing an accidental `;``` line so the example renders correctly.

Reference URL: https://github.com/pavan-sh/tanstack.com/pull/new/docs/fix-docs-info-code-fence-clean
Screenshot -
Screenshot 2026-04-20 at 7 52 33 AM

Summary by CodeRabbit

Documentation

  • Fixed formatting inconsistencies in code block examples by removing stray characters, ensuring proper markdown rendering and clean presentation. This improves the readability and visual consistency of all technical documentation, making it easier for users to understand and follow code examples and best practices documented throughout the guides and reference materials.

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 20, 2026

👷 Deploy request for tanstack pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 171b3df

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0af2b0b0-b3b5-4f33-be42-19d7339d5891

📥 Commits

Reviewing files that changed from the base of the PR and between 0e6dc8b and 171b3df.

📒 Files selected for processing (1)
  • docs-info.md
💤 Files with no reviewable changes (1)
  • docs-info.md

📝 Walkthrough

Walkthrough

A documentation file was corrected by removing a stray trailing character sequence from a fenced code block example in the "Code Blocks" section, ensuring the markdown syntax is properly closed without extraneous characters.

Changes

Cohort / File(s) Summary
Documentation fix
docs-info.md
Removed stray trailing sequence (; with backticks) from a fenced code block example in the "Code Blocks" section to ensure proper markdown fence formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

🐰 A semicolon and ticks did stray,
From where they ought rightly stay,
But a swift fix made it right,
The markdown fence shines bright,
Clean and proper today!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing a malformed markdown code fence (the stray `;``` sequence) from the docs-info guide to fix rendering.
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.

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