Docs: Source Maps page scope is errors-only; omits profiling use case
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start with the JavaScript Source Maps page linked in the issue, then compare its wording with the JavaScript Profiling page and its source maps section. Update the Source Maps documentation to cover readable error stack traces and deobfuscated profiling function names, and add the profiling cross-reference if appropriate; done means both use cases are clear to readers.
Written by the indexing model from the issue text.
Description
Summary
The Source Maps page describes source maps solely in the context of errors, stating: "Upload your source maps to Sentry to enable readable stack traces in your errors." However, the Profiling page explicitly calls out source maps as a benefit of Sentry Profiling (vs. Chrome DevTools):
Source maps — Deobfuscated function names (Sentry Profiling) vs. Minified names (Chrome DevTools)
This creates a documentation gap: a user setting up profiling who follows the source maps page would have no indication that source maps also apply to (and benefit) profiling data — deobfuscating function names in profiles, not just in error stack traces.
Scope
- Update the Source Maps page intro and/or description to reflect that source maps benefit both errors (stack traces) and profiling (function names).
- Optionally, add a cross-reference on the Profiling page pointing to the Source Maps setup docs.
- No change to actual SDK behavior — this is a docs-only clarification.
References
- Source Maps doc: https://docs.sentry.io/platforms/javascript/sourcemaps/
- Profiling doc: https://docs.sentry.io/platforms/javascript/profiling/
Action taken on behalf of Prithvi Rajakumar.
- Dominant language
- MDX
- Stars
- 446
- Forks
- 1.7k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 312
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-docs
-
Docs Platform: Android SDKs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
getsentry/sentry-docs#19438 · 1 comment ·
-
Docs Platform: Python SDKs
Difficulty 1/5 Under an hour Newbie friendliness 92/100
getsentry/sentry-docs#19432 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-docs#19347 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
getsentry/sentry-docs#19182 · 1 comment ·
-
Docs Good First Issue Platform: PHP SDKs
Difficulty 1/5 Under an hour Newbie friendliness 90/100
getsentry/sentry-docs#19177 · 2 comments ·
All issues in getsentry/sentry-docs
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·