Skip to content

docs(devtools): make markdown consistent#10987

Open
dborysov wants to merge 1 commit into
TanStack:mainfrom
dborysov:main
Open

docs(devtools): make markdown consistent#10987
dborysov wants to merge 1 commit into
TanStack:mainfrom
dborysov:main

Conversation

@dborysov

@dborysov dborysov commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

🎯 Changes

Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?

In the meantime, I just converted all links to html.

Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr. (N/A - Docs only change)

🚀 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
    • Improved the devtools docs across multiple frameworks with clearer third-party browser extension links.
    • Added browser icons next to Chrome, Firefox, and Edge extension links for easier visual recognition.

Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?

In the meantime, I just converted all links to html.

Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated the framework devtools docs to show Chrome, Firefox, and Edge extension links with inline browser logo images instead of plain text links.

Changes

Browser devtools extension links

Layer / File(s) Summary
Inline icon links
docs/framework/angular/devtools.md, docs/framework/preact/devtools.md, docs/framework/react/devtools.md, docs/framework/solid/devtools.md, docs/framework/svelte/devtools.md, docs/framework/vue/devtools.md
Each framework devtools guide now renders the Chrome, Firefox, and Edge extension items as icon-prefixed links instead of plain text links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 I hopped through docs with a tiny grin,
Chrome, Firefox, and Edge now glow within.
Icons beside the links do peep and gleam,
A carrot-bright trail in each framework theme.
Hop-hop—devtools shine in a tidy dream.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the docs-focused markdown consistency change across devtools files.
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.
Description check ✅ Passed The PR description follows the required template and includes changes, checklist, and release impact sections.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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