Feat(docs): Improved docs by betegon · Pull Request #1082 · getsentry/spotlight

betegon · 2025-10-31T12:17:26Z

improved docs with Electron app + CLI + MCP

vercel · 2025-10-31T12:17:33Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
spotlightjs	Ready	Preview	Comment	Oct 31, 2025 7:11pm

BYK

Reviewed until the MCP section

packages/website/src/content/docs/docs/cli/index.mdx

packages/website/src/content/docs/docs/cli/reference.mdx

packages/website/src/content/docs/docs/cli/run.mdx

packages/website/src/content/docs/docs/desktop-app/index.mdx

BYK · 2025-10-31T13:00:59Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+Share debugging sessions:
+
+1. One team member runs the desktop app
+2. Others can view the UI via browser at `http://localhost:8969`


This requires tunneling with a tool like Ngrok

betegon · 2025-10-31T21:13:20Z

Merging this. We'll follow up with more improvements soon.

BYK · 2025-10-31T23:08:48Z

packages/website/src/content/docs/docs/cli/reference.mdx

+# Service 2 (frontend - connects to same sidecar)
+spotlight run -p 8969 npm run dev:frontend


This may not work

BYK · 2025-10-31T23:11:00Z

packages/website/src/content/docs/docs/cli/run.mdx

+spotlight run npm test
+
+# Capture traces during integration tests
+spotlight run -p 0 pytest tests/


Suggested change

spotlight run -p 0 pytest tests/

spotlight run pytest tests/

BYK · 2025-10-31T23:12:00Z

packages/website/src/content/docs/docs/cli/run.mdx

+    ```go
+    // Sentry will automatically use the SENTRY_SPOTLIGHT env var
+    sentry.Init(sentry.ClientOptions{
+        Dsn: "your-dsn", // Optional
+    })


Will it? - getsentry/sentry-go#1085

BYK · 2025-10-31T23:13:22Z

packages/website/src/content/docs/docs/cli/run.mdx

+```bash
+npm install -g @spotlightjs/sidecar
+# or use npx
+npx @spotlightjs/sidecar run node server.js


We may also mention this script: http://spotlightjs.com/install.sh

Not ideal but:

curl http://spotlightjs.com/install.sh | sh

BYK · 2025-10-31T23:18:46Z

packages/website/src/content/docs/docs/cli/tail.mdx

+**Example output:**
+```
+🔴 ERROR | 2025-10-31 14:23:45
+TypeError: Cannot read property 'id' of undefined
+  at getUserData (api/users.js:42)
+  at processRequest (api/middleware.js:18)
+
+📝 LOG | 2025-10-31 14:23:46
+[INFO] Request processed successfully
+  user_id: 12345
+  duration: 234ms
+```


This looks like hallucination

BYK · 2025-10-31T23:20:06Z

packages/website/src/content/docs/docs/cli/tail.mdx

+
+**Perfect for:**
+- Log aggregation tools
+- Piping to other CLI tools


Such as the ones at https://www.heroku.com/blog/hutils-explore-your-structured-data-logs/ or https://github.com/pamburus/hl

BYK · 2025-10-31T23:20:49Z

packages/website/src/content/docs/docs/cli/tail.mdx

+**Perfect for:**
+- Creating incident reports
+- Sharing errors in documentation
+- GitHub issues or PRs


And feeding into LLMs?

BYK · 2025-10-31T23:21:33Z

packages/website/src/content/docs/docs/cli/tail.mdx

+### Debug Mode
+
+Enable verbose logging to troubleshoot issues:
+
+```bash
+spotlight tail -d
+# or
+spotlight tail --debug
+```


Not really useful?

BYK · 2025-10-31T23:21:59Z

packages/website/src/content/docs/docs/cli/tail.mdx

+
+```bash
+# Start sidecar and run tests, output as JSON
+spotlight tail -f json > spotlight-events.json &


This should be ndjson too

BYK · 2025-10-31T23:23:02Z

packages/website/src/content/docs/docs/cli/tail.mdx

+
+```
+🔴 ERROR | 2025-10-31 14:23:45.123
+TypeError: Cannot read property 'id' of undefined
+
+Location: api/users.js:42:10
+
+Stack Trace:
+  at getUserData (api/users.js:42:10)
+  at processRequest (api/middleware.js:18:5)
+  at Layer.handle (express/lib/router/layer.js:95:5)
+
+Context:
+  request_id: req_abc123
+  user_id: 12345
+  method: GET
+  path: /api/users/12345


Looks like hallucination again

BYK · 2025-10-31T23:24:09Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+- Headless or mobile development
+- When you want debugging in a separate window
+- Team members who prefer desktop apps
+- Quick setup without browser configuration


Browser configuration?

BYK · 2025-10-31T23:25:31Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+:::note[Other Platforms]
+Currently, the desktop app is available for macOS. Windows and Linux support is coming soon.
+
+In the meantime, you can use the [CLI](/docs/cli/) or [browser-based UI](/docs/sidecar/npx/).


Suggested change

In the meantime, you can use the [CLI](/docs/cli/) or [browser-based UI](/docs/sidecar/npx/).

In the meantime, you can use the [CLI](/docs/cli/) with the browser-based UI.

BYK · 2025-10-31T23:25:56Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+
+The app automatically starts a Spotlight sidecar server:
+
+- Default port: 8969 (configurable in settings)


Is it really?

BYK · 2025-10-31T23:26:59Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+### Changing the Port
+
+If port 8969 is already in use:
+
+1. Open Spotlight **Settings** (via menu or gear icon)
+2. Change the **Sidecar Port** setting
+3. Restart the app
+4. Update your app's SDK configuration to match


This sounds like BS to me. We don't have any settings?

BYK · 2025-10-31T23:27:17Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+### UI Preferences
+
+Customize the interface:
+
+- **Theme**: Choose light or dark mode
+- **Font size**: Adjust for readability
+- **Panel layout**: Configure which panels are visible


BYK · 2025-10-31T23:28:23Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+- ✅ You want machine-readable output
+
+### Use Browser UI When:
+- ✅ You want overlay on your application


Overlay is long-dead. Feel like this is coming from agent rules file or something.

BYK · 2025-10-31T23:28:53Z

packages/website/src/content/docs/docs/desktop-app/index.mdx

+### Use Browser UI When:
+- ✅ You want overlay on your application
+- ✅ You're debugging frontend web apps


This entire section is no longer applicable.

Suggested change

### Use Browser UI When:

- ✅ You want overlay on your application

- ✅ You're debugging frontend web apps

BYK · 2025-10-31T23:31:30Z

packages/website/src/content/docs/docs/sidecar/index.mdx

+**Via UI Config:**
+See [Configuration reference](/docs/reference/configuration/#sidecar) for UI-side configuration.


BYK · 2025-10-31T23:31:48Z

packages/website/src/content/docs/docs/sidecar/index.mdx

+<CardGrid>
+  <LinkCard title="CLI Commands" href="/docs/cli/" description="Run with spotlight-sidecar command" />
+  <LinkCard title="NPX" href="./npx/" description="Quick start with npx" />
+  <LinkCard title="Webpack Plugin" href="./webpack/" description="Auto-start with webpack" />


BYK · 2025-10-31T23:32:08Z

packages/website/src/content/docs/docs/sidecar/index.mdx

+**Standalone Server:**
+```bash
+# Using CLI
+spotlight-sidecar server


Death to spotlight-sidecar

BYK · 2025-10-31T23:32:59Z

packages/website/src/content/docs/docs/sidecar/index.mdx

+
+[Learn more about Desktop App →](/docs/desktop-app/)
+
+## Next Steps


Half of this file seems redundant as it covers the same things with spotlight CLI. Those parts should be merged.

BYK

This is a huge improvement, thanks so much!

new dooocs

9f2b512

fix spotlight run commands

935590a

vercel bot deployed to Preview October 31, 2025 12:40 View deployment

betegon added 2 commits October 31, 2025 13:40

fix tail command

25cfb4f

api reference fix

e5dd2db

vercel bot deployed to Preview October 31, 2025 12:42 View deployment

betegon added 2 commits October 31, 2025 13:43

fix spotlight command

bdf4da4

fix mcp command

8187eb8

vercel bot deployed to Preview October 31, 2025 12:47 View deployment

BYK reviewed Oct 31, 2025

View reviewed changes

remove attachments event type

9b24de7

vercel bot deployed to Preview October 31, 2025 15:32 View deployment

betegon added 2 commits October 31, 2025 17:00

add format references

3bbc648

add format references

43a2ac4

vercel bot deployed to Preview October 31, 2025 16:01 View deployment

betegon added 2 commits October 31, 2025 17:21

ndjson

5a7d9b4

version for spotlight

0b12eff

vercel bot deployed to Preview October 31, 2025 16:22 View deployment

dynamic port assignment

b62c910

vercel bot deployed to Preview October 31, 2025 16:25 View deployment

vercel bot deployed to Preview October 31, 2025 16:55 View deployment

run command description

8d033a3

vercel bot deployed to Preview October 31, 2025 16:57 View deployment

small fixes

dd44356

vercel bot deployed to Preview October 31, 2025 17:15 View deployment

port dynamically assigned

27814b7

vercel bot deployed to Preview October 31, 2025 19:03 View deployment

add spotlight dsn

f7c5c9f

vercel bot deployed to Preview October 31, 2025 19:09 View deployment

betegon marked this pull request as ready for review October 31, 2025 19:12

betegon requested a review from MathurAditya724 October 31, 2025 19:12

betegon merged commit 0bd999d into main Oct 31, 2025
20 checks passed

betegon deleted the bete/feat/improve-docs branch October 31, 2025 21:13

BYK reviewed Oct 31, 2025

View reviewed changes

This was referenced Oct 31, 2025

Update docs for mobile using simulators #1038

Closed

Revamp outdated docs #985

Closed

Fix(docs): Small fixes for the new packages #1088

Merged

		# Service 2 (frontend - connects to same sidecar)
		spotlight run -p 8969 npm run dev:frontend

	In the meantime, you can use the [CLI](/docs/cli/) or [browser-based UI](/docs/sidecar/npx/).
	In the meantime, you can use the [CLI](/docs/cli/) with the browser-based UI.


		The app automatically starts a Spotlight sidecar server:

		- Default port: 8969 (configurable in settings)

	### Use Browser UI When:
	- ✅ You want overlay on your application
	- ✅ You're debugging frontend web apps

		Via UI Config:
		See [Configuration reference](/docs/reference/configuration/#sidecar) for UI-side configuration.


		[Learn more about Desktop App →](/docs/desktop-app/)

		## Next Steps

Uh oh!

Conversation

betegon commented Oct 31, 2025

Uh oh!

vercel bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

betegon commented Oct 31, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

vercel bot commented Oct 31, 2025 •

edited

Loading