Skip to content

docs(js): move API-related content from Manual Setup to APIs page #13327

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

inventarSarah
Copy link
Collaborator

DESCRIBE YOUR PR

Added the APIs mentioned from our Next.js manual setup QS guide to the APIs page.
Removed content from Next.js manual setup QS guide we no longer need there (and have documented elsewhere).

Closes: #13289

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

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

Copy link

vercel bot commented Apr 10, 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 Apr 24, 2025 10:44am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 24, 2025 10:44am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 24, 2025 10:44am

@inventarSarah inventarSarah requested review from mydea and chargome April 10, 2025 12:06
@inventarSarah
Copy link
Collaborator Author

inventarSarah commented Apr 10, 2025

@mydea I leave this pr on Draft for now in case you want to pick it up and fine-tune my API page updates -- let me know :)
(I tried to define the properties like some of the other definitions have but I was unsure how to define them for the functions I added)

Copy link

codecov bot commented Apr 14, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.14MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.47MB -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 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/dgGYrki-*.js (New) 578 bytes 578 bytes 100.0% 🚀
static/dgGYrki-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/3XbmzHxbCCVy-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/3XbmzHxbCCVy-*.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.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%


<SdkApi
name="withServerActionInstrumentation"
signature="function withServerActionInstrumentation(serverActionName: string, options?: Options, callback: A): Promise<ReturnType<A>>"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it makes more sense to format this with line breaks similar to the example before it, just for the sake of readability, something like:

function withServerActionInstrumentation(
  serverActionName: string,
  options?: Options,
  callback: A,
): Promise<ReturnType<A>>;

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good idea, thanks!
I've formatted all the functions I've added so they are more readable now 👍

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Added some formatting suggestions, but overall looks great!

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

Looks good but we need to make this a bit more discoverable as this is an important feature. We still need to add the link in "Next Steps" and maybe also place it somewhere else as well wdyt?

@inventarSarah
Copy link
Collaborator Author

Looks good but we need to make this a bit more discoverable as this is an important feature. We still need to add the link in "Next Steps" and maybe also place it somewhere else as well wdyt?

@chargome yes, thank you! I added the link to Next Steps in both Next.js quick start guides

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.

Revisit Next.js Manual Setup: Remove/move APIs content
3 participants