Skip to content

Conversation

@jaffrepaul
Copy link
Contributor

@jaffrepaul jaffrepaul commented Nov 3, 2025

DESCRIBE YOUR PR

I found repeat typos in a few files so decided to dig deeper. Turns out this was overdue.

  • Scanned repo and fixed a number of typos across various file types - mostly non-functional (comments, etc) but found some that could effect conditional logic
  • Added typo rules for special cases and files to ignore
  • Added GH action to run spell checking tool on PRs. It's snappy - written in Rust, shouldn't add much overhead if any.
  • Also included it as a pre-commit hook, although this flow (.pre-commit-config.yaml) is optional and not clear how many users use this
  • Renamed the GH Action workflow, was appearing twice and now will show as:
    CI / Lint
    CI / Check Typos
    CI / Test

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

@vercel
Copy link

vercel bot commented Nov 3, 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 Nov 3, 2025 10:10pm
sentry-docs Ready Ready Preview Comment Nov 3, 2025 10:10pm

cursor[bot]

This comment was marked as outdated.

@codecov
Copy link

codecov bot commented Nov 3, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.16MB -9 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.9MB 61.96kB (0.48%) ⬆️

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.74MB -0.0%
../instrumentation.js -3 bytes 1.07MB -0.0%
9523.js -3 bytes 1.04MB -0.0%
../app/[[...path]]/page.js.nft.json 20.66kB 867.78kB 2.44%
../app/platform-redirect/page.js.nft.json 20.66kB 867.69kB 2.44%
../app/sitemap.xml/route.js.nft.json 20.66kB 864.92kB 2.45%
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/chunks/4145-*.js -3 bytes 50.94kB -0.01%
server/middleware-*.js -6.46kB 1.0kB -86.59%
server/middleware-*.js 6.46kB 7.46kB 645.5% ⚠️
static/WAhVgjZuTFtn1qJOlhe79/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/WAhVgjZuTFtn1qJOlhe79/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/My97UCAYSNmnof3lkBxpm/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/My97UCAYSNmnof3lkBxpm/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@KyleTryon KyleTryon left a comment

Choose a reason for hiding this comment

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

Awesome addition. I am pretty impressed with some of the matches it found, like the correction for OpenTelemetry.

Definitely adding this tool to my bag of tricks.

name: Check Typos
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be able to be updated to v5, unless set for a specific reason.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah nice, good catch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed in c72e050

- id: eslint
entry: node_modules/.bin/eslint
- repo: https://github.com/crate-ci/typos
rev: v1.26.8
Copy link
Contributor

Choose a reason for hiding this comment

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

v1.39.0 came out 3 days ago.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sick, thx!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed in c72e050

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.

Build loads, looks good. Thanks for updating the linter too!

@jaffrepaul jaffrepaul merged commit 3814d0e into master Nov 4, 2025
16 checks passed
@jaffrepaul jaffrepaul deleted the fix-typos branch November 4, 2025 05:33
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.

4 participants