Align Remix README with the v11 server and Vite setup

Open Beginner friendly
#24,558 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript, vite
Domain
documentation

Research direction

Start with packages/remix/README.md and compare its v11 server and Vite setup with the requested sentryRemixVitePlugin, instrumentation file, --import preload, and entry.server.tsx example. Update the route, instrumentation, error-handler, and source-map guidance while retaining the classic-compiler alternative and pointing Cloudflare details to the linked guide; done means the README presents a complete, accurate setup.

Written by the indexing model from the issue text.

Description

Task

Update packages/remix/README.md to document sentryRemixVitePlugin from @sentry/remix/vite for route parameterization, build-time dependency instrumentation, and source-map uploads. Correct the claim that withSentry alone provides parameterized route names, and label the existing source-map CLI instructions as the classic-compiler alternative.

While updating the setup, close two existing gaps: initialize the server SDK in a separate instrumentation file preloaded with --import, and show export const handleError = Sentry.sentryHandleError in entry.server.tsx. These gaps predate v11 but are needed for a complete example.

Keep Cloudflare-specific instructions in the linked guide.

Docs PR: getsentry/sentry-docs#19425

Dominant language
TypeScript
Stars
8.7k
Forks
1.9k
Avg merge
1d 18h
Merged PRs (30d)
543

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-javascript

All issues in getsentry/sentry-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.