Skip to content

docs(guides): Improve intro paragraph formatting and expand custom spans description - #17169

Merged
jaffrepaul merged 3 commits into
masterfrom
guides-updates
May 15, 2026
Merged

docs(guides): Improve intro paragraph formatting and expand custom spans description#17169
jaffrepaul merged 3 commits into
masterfrom
guides-updates

Conversation

@jaffrepaul

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Minor formatting and content improvements across the guides section:

  • Split dense opening paragraphs in issues-errors, logs, metrics, querying-traces, and session-replay guides into two sentences for better readability
  • Expanded the custom-spans guide intro to clarify what custom spans add (business context, logical groupings, attributes) and note that they often appear as parents of auto-generated child spans

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

@vercel

vercelBot commented Mar 30, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
develop-docsReadyReadyPreview, CommentMay 15, 2026 1:31pm
sentry-docsReadyReadyPreview, CommentMay 15, 2026 1:31pm

Request Review

@coolguyzonecoolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY for your attention to detail 🫡

@github-actions

Copy link
Copy Markdown
Contributor

This pull request has been automatically marked as stale because it has not had recent activity.
It will be closed in 7 days if no further activity occurs.

If this PR is still relevant, please:

  • Push new commits, or
  • Leave a comment to keep it open

Thank you for your contribution!

@jaffrepaul
jaffrepaul merged commit e2ad258 into masterMay 15, 2026
21 checks passed
@jaffrepaul
jaffrepaul deleted the guides-updates branch May 15, 2026 21:10
sentrivana pushed a commit that referenced this pull request May 18, 2026
…ans description (#17169)
## DESCRIBE YOUR PR
Minor formatting and content improvements across the guides section:
- Split dense opening paragraphs in `issues-errors`, `logs`, `metrics`,
`querying-traces`, and `session-replay` guides into two sentences for
better readability
- Expanded the `custom-spans` guide intro to clarify what custom spans
add (business context, logical groupings, attributes) and note that they
often appear as parents of auto-generated child spans
## IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: 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
added an urgent due date to it.
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](https://github.com/orgs/getsentry/teams/docs)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jaffrepaul@rahulchhabria@coolguyzone