Skip to content

docs(solidstart): Document the SolidStart 2 setup - #19376

Draft
JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1515-solidstart-getting-started-manual-setup
Draft

docs(solidstart): Document the SolidStart 2 setup#19376
JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1515-solidstart-getting-started-manual-setup

Conversation

@JPeer264

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

closes SDK-1515

npm install @solidjs/start gives SolidStart 2 today, and the guide described SolidStart 1 only. On SolidStart 2 there is no app.config.ts, @solidjs/start/config exports no defineConfig, the build emits no .output/server/instrument.server.mjs, and vinxi is not installed, so the documented config was ignored and the documented start command exited with ERR_MODULE_NOT_FOUND.

Give each affected step a SolidStart 2 tab next to the SolidStart 1 one:

  • Server init moves to a Nitro startup plugin, server/plugins/sentry.ts.
  • The build config moves to vite.config.ts with sentrySolidStart from @sentry/solidstart/vite.
  • The server starts with a plain node .output/server/index.mjs. The Vite plugin instruments dependencies at build time, so no preload is needed.
  • Source map options move into sentrySolidStart().

Add a SolidStart prerequisites include naming the supported versions, so readers know which set of tabs applies to them. The guide fell back to the default include, which names no framework version at all.

Scope the --import, limited server tracing and dynamic import installation methods to SolidStart 1, since all three configure withSentry in app.config.ts.

Import sentryBeforeResponseMiddleware from @sentry/solidstart. The package exports ., ./solidrouter and ./vite, so the documented @sentry/solidstart/middleware path failed with
ERR_PACKAGE_PATH_NOT_EXPORTED.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

`npm install @solidjs/start` gives SolidStart 2 today, and the guide
described SolidStart 1 only. On SolidStart 2 there is no `app.config.ts`,
`@solidjs/start/config` exports no `defineConfig`, the build emits no
`.output/server/instrument.server.mjs`, and vinxi is not installed, so the
documented config was ignored and the documented start command exited with
`ERR_MODULE_NOT_FOUND`.

Give each affected step a SolidStart 2 tab next to the SolidStart 1 one:

- Server init moves to a Nitro startup plugin, `server/plugins/sentry.ts`.
- The build config moves to `vite.config.ts` with `sentrySolidStart` from
  `@sentry/solidstart/vite`.
- The server starts with a plain `node .output/server/index.mjs`. The Vite
  plugin instruments dependencies at build time, so no preload is needed.
- Source map options move into `sentrySolidStart()`.

Add a SolidStart prerequisites include naming the supported versions, so
readers know which set of tabs applies to them. The guide fell back to the
default include, which names no framework version at all.

Scope the `--import`, limited server tracing and dynamic import
installation methods to SolidStart 1, since all three configure
`withSentry` in `app.config.ts`.

Import `sentryBeforeResponseMiddleware` from `@sentry/solidstart`. The
package exports `.`, `./solidrouter` and `./vite`, so the documented
`@sentry/solidstart/middleware` path failed with
`ERR_PACKAGE_PATH_NOT_EXPORTED`.

Refs SDK-1515
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@JPeer264
JPeer264 requested review from chargome and s1gr1d September 11, 2026 16:22
@JPeer264 JPeer264 self-assigned this Sep 11, 2026
@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 11, 2026 4:29pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Sep 11, 2026 4:29pm UTC

Request Review

@linear-code

linear-code Bot commented Sep 11, 2026

Copy link
Copy Markdown

SDK-1515

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

js-v11-docs Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant