Skip to content

Conversation

@philprime
Copy link
Member

@philprime philprime commented Sep 23, 2025

DESCRIBE YOUR PR

This PR creates individual index.mdx files for the watchOS, macOS, tvOS, and visionOS platform root pages. Previously, these pages were inheriting from a common index.mdx file, which resulted in all of them incorrectly displaying "iOS" as their title.

By adding specific index.mdx files with the correct frontmatter title for each platform, their respective root pages will now display the accurate platform name (e.g., "watchOS" for watchOS). This addresses the issue raised in the Slack thread.

IS YOUR CHANGE URGENT?

  • 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


Slack Thread

Open in Cursor Open in Web

Co-authored-by: phil.niedertscheider <phil.niedertscheider@sentry.io>
@cursor
Copy link

cursor bot commented Sep 23, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@vercel
Copy link

vercel bot commented Sep 23, 2025

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

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Sep 26, 2025 0:18am
sentry-docs Ready Ready Preview Comment Sep 26, 2025 0:18am

@codeowner-assignment codeowner-assignment bot requested a review from a team September 23, 2025 07:54
@philprime philprime self-assigned this Sep 23, 2025
@philprime philprime changed the title Update platform titles for Apple OS pages fix(apple): Update platform titles for Apple OS pages Sep 23, 2025
@codecov
Copy link

codecov bot commented Sep 23, 2025

Bundle Report

Changes will decrease total bundle size by 1.21kB (-0.01%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.13MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs* 12.86MB -1.2kB (-0.01%) ⬇️

ℹ️ *Bundle size includes cached data from a previous commit

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json -313 bytes 825.75kB -0.04%
../app/platform-redirect/page.js.nft.json -313 bytes 825.66kB -0.04%
../app/sitemap.xml/route.js.nft.json -313 bytes 822.89kB -0.04%
../app/[[...path]]/page.js -256 bytes 613.04kB -0.04%

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] -256 bytes 3.36MB -0.01%
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 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/f9dK1GwDAtU9PyuV2r8Pc/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/f9dK1GwDAtU9PyuV2r8Pc/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/ztl5kvrJDACX_FoBskRpU/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/ztl5kvrJDACX_FoBskRpU/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

cursoragent and others added 2 commits September 23, 2025 08:40
This commit updates the Apple platform documentation to improve clarity and consistency across different platforms. It refactors the content to use a more standardized structure and includes updated code examples and feature descriptions.

Co-authored-by: phil.niedertscheider <phil.niedertscheider@sentry.io>
cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

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

@philprime - looks good. I added a missing iOS header for the iOS page (I think it was left out because the root index is built from the new includes file), and added descriptions to each page, which helps with SEO.

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

LGTM, with a few comments. Thanks

Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>
@philprime
Copy link
Member Author

philprime commented Sep 26, 2025

@sfanahata I changed it so that the common page also uses the includes. To me it looks fine now, please double-check

Copy link
Contributor

@sfanahata sfanahata 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! Let's 🚢

@philprime philprime merged commit 2df5e0d into master Sep 29, 2025
13 checks passed
@philprime philprime deleted the cursor/update-platform-titles-for-apple-os-pages-2bd0 branch September 29, 2025 08:49
@github-actions github-actions bot locked and limited conversation to collaborators Oct 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants