Skip to content

Assorted copy & URL updates #14222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

jaffrepaul
Copy link
Contributor

@jaffrepaul jaffrepaul commented Jul 1, 2025

<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. -->

## DESCRIBE YOUR PR
This PR makes two documentation updates:
1.  Removes "With insights," from the first paragraph of the Insights overview page (`docs/product/insights/overview/index.mdx`) to eliminate redundancy with the page's H2 and description.
2.  Adds content to the "Agent Pipelines vs Direct LLM Calls" callout on the Agents dashboard page (`docs/product/insights/agents/dashboard.mdx`). This provides important context on the difference between AI pipelines and direct LLM calls, and includes a link to relevant manual instrumentation documentation.

## 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:*

- [X] 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)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section. -->

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 

Copy link

vercel bot commented Jul 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 1, 2025 8:15pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 1, 2025 8:15pm

@codeowner-assignment codeowner-assignment bot requested a review from a team July 1, 2025 18:22
Copy link

codecov bot commented Jul 1, 2025

Bundle Report

Changes will increase total bundle size by 862.62kB (4.09%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.8MB 862.62kB (7.89%) ⬆️
sentry-docs-client-array-push 9.8MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 873.24kB -0.0%
static/chunks/7750-*.js -3 bytes 415.85kB -0.0%
static/64EH76wd5xpFK93dwsezc/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/64EH76wd5xpFK93dwsezc/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/_eFWOD9iKTJa-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/_eFWOD9iKTJa-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
../instrumentation.js -3 bytes 973.36kB -0.0%
9523.js -3 bytes 949.31kB -0.0%
../app/[[...path]]/page.js.nft.json 287.54kB 691.95kB 71.1% ⚠️
../app/platform-redirect/page.js.nft.json 287.54kB 691.86kB 71.12% ⚠️
../app/sitemap.xml/route.js.nft.json 287.54kB 689.83kB 71.48% ⚠️

@jaffrepaul jaffrepaul marked this pull request as ready for review July 1, 2025 19:19
@jaffrepaul jaffrepaul requested review from coolguyzone and sfanahata and removed request for a team July 1, 2025 19:19
@@ -64,4 +64,6 @@ When your AI agents are part of larger applications (like web servers or APIs),

<Alert title="Agent Pipelines vs Direct LLM Calls">

Creating an AI pipeline is different than calling an LLM. If you're creating AI pipelines by calling LLMs directly (without using a tool like LangChain), consider using [manual AI instrumentation](/platforms/python/tracing/instrumentation/custom-instrumentation/ai-agents-module).
Copy link
Contributor

Choose a reason for hiding this comment

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

@jaffrepaul - can you share why you put this alert at the bottom of the page? I would have assumed this information would be more useful closer to the beginning of the doc where we start with "once you've set up the SDK".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The Alert component was already there, it just had no content in it 😀 There may be a larger convo around the best flow for this info, but (literally) filling in the gaps for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants