Merge branch 'master' into aspnetcore-6

Author: cleptric

.env.example

@@ -5,3 +5,4 @@
 
 NEXT_PUBLIC_ALGOLIA_APP_ID=
 NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=
+NEXT_PUBLIC_SENTRY_DSN=

.github/workflows/lint-404s.yml

@@ -7,7 +7,7 @@ on:
     branches: [master]
 
 jobs:
-  index:
+  lint-404:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -36,14 +36,13 @@ jobs:
             ${{ github.workspace }}/node_modules
             ${{ github.workspace }}/.next/cache
             ${{ github.workspace }}/.eslintcache
-          key: node-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+          key: node-${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            node-${{ runner.os }}-
+            node-${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-
 
       - run: yarn install --frozen-lockfile
-        if: steps.cache.outputs.cache-hit != 'true'
 
-      - run: yarn build
+      - run: yarn next build
         if: steps.filter.outputs.docs == 'true'
         env:
           SENTRY_DSN: https://[email protected]/0

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Lint, and Test
+name: CI
 
 on:
   push:
@@ -11,7 +11,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v5
 
       - name: Internal github app token
         id: token
@@ -62,11 +62,19 @@ jobs:
         with:
           github-token: ${{ steps.token.outputs.token }}
 
+  job_typos:
+    name: Check Typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Check spelling with typos
+        uses: crate-ci/typos@master
+
   job_test:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v5
       - name: Set up Node
         uses: actions/setup-node@v4
         with:

.gitignore

@@ -50,9 +50,10 @@ typings/
 # Output of 'npm pack'
 *.tgz
 
-# dotenv environment variables file
+# dotenv environment variables files
 .env
-.env.development
+.env.*
+!.env.example
 
 # gatsby files
 .cache/
@@ -96,6 +97,8 @@ tsconfig.tsbuildinfo
 # Ignore generated files
 /public/md-exports/
 public/mdx-images/*
+public/og-images/*
+!public/og-images/README.md
 
 # yalc
 .yalc

.pre-commit-config.yaml

@@ -22,11 +22,15 @@ repos:
       - id: debug-statements
       - id: flake8
       - id: fix-encoding-pragma
-        args: ["--remove"]
+        args: ['--remove']
   - repo: https://github.com/getsentry/pre-commit-hooks
     rev: f3237d2d65af81d435c49dee3593dc8f03d23c2d
     hooks:
       - id: prettier
         entry: node_modules/.bin/prettier
       - id: eslint
         entry: node_modules/.bin/eslint
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.39.0
+    hooks:
+      - id: typos

_typos.toml

@@ -0,0 +1,75 @@
+[default]
+# Regex patterns to ignore
+extend-ignore-re = [
+  "\\bUE\\b",     # Unreal Engine abbreviation
+  "\\bUE_LOG\\b", # Unreal Engine logging macro
+  "\\bue4\\b",    # Unreal Engine 4
+  "\\bue5\\b",    # Unreal Engine 5
+  "\\bue\\d+\\b", # Any UE version (ue5, ue6, etc.)
+]
+
+[files]
+# Files and patterns to exclude from spell checking
+extend-exclude = [
+  # Design and binary files
+  "*.excalidraw", # Diagram files contain random IDs
+  "*.png",
+  "*.jpg",
+  "*.jpeg",
+  "*.gif",
+  "*.svg",
+  "*.webp",
+
+  # Data and configuration files
+  "*.json",            # JSON files have many false positives
+  "*.lock",            # Package lock files
+  "yarn.lock",         # Yarn lock file
+  "package-lock.json", # NPM lock file
+
+  # Documentation assets
+  "public/_platforms/*.json", # Platform metadata
+  "public/pdfs/*.pdf",        # PDFs can't be edited programmatically
+
+  # Build artifacts and dependencies
+  ".next/**",        # Next.js build output
+  "node_modules/**", # Dependencies
+  "dist/**",         # Distribution builds
+  "build/**",        # Build output
+]
+
+[default.extend-words]
+# Technical terms and product names that are spelled correctly
+# .NET ecosystem
+Paket = "Paket" # .NET package manager (legitimate tool)
+paket = "paket" # .NET package manager CLI command
+
+# Platform-specific terms
+ITMS = "ITMS" # Apple error code prefix (legitimate)
+SEH = "SEH"   # Structured Exception Handling (Windows API)
+EDE = "EDE"   # Cipher name component (3DES_EDE_CBC_SHA)
+UE = "UE"     # Unreal Engine abbreviation
+UE4 = "UE4"   # Unreal Engine 4
+UE5 = "UE5"   # Unreal Engine 5
+
+# Cloud/Infrastructure
+nodejs_als = "nodejs_als" # Cloudflare compatibility flag (correct spelling)
+als = "als"               # Part of nodejs_als flag
+
+# Common abbreviations in tech docs
+DSN = "DSN"   # Data Source Name (Sentry)
+DSNs = "DSNs" # Plural
+SDK = "SDK"   # Software Development Kit
+SDKs = "SDKs" # Plural
+API = "API"   # Application Programming Interface
+APIs = "APIs" # Plural
+MCP = "MCP"   # Model Context Protocol
+NPM = "NPM"   # Node Package Manager
+
+# Code identifiers that are intentionally "misspelled" or match external systems
+# Note: These should ONLY include cases where the spelling is intentional
+# (e.g., matching an external API/constant name we don't control)
+childs = "childs"                       # Intentional variable name in mdx-deflist.ts
+aso = "aso"                             # Intentional variable name in utils.ts (short for "a sidebar order")
+MIGRATED_GETTING_STARTD_DOCS = "MIGRATED_GETTING_STARTD_DOCS" # Matches actual constant in Sentry backend (external)
+STARTD = "STARTD"                       # Part of MIGRATED_GETTING_STARTD_DOCS - needed because typos parses words in markdown text
+ERRO = "ERRO"                           # Special case - Part of "ERRORs" in legacy-sdk/integrations.mdx (logging level context)

app/[[...path]]/page.tsx

@@ -194,12 +194,47 @@ function formatCanonicalTag(tag: string) {
   return tag;
 }
 
+// Helper function to resolve OG image URLs
+function resolveOgImageUrl(
+  imageUrl: string | undefined,
+  domain: string,
+  pagePath: string[]
+): string | null {
+  if (!imageUrl) {
+    return null;
+  }
+
+  // Remove hash fragments (e.g., #600x400 from remark-image-size)
+  const cleanUrl = imageUrl.split('#')[0];
+
+  // External URLs - return as is
+  if (cleanUrl.startsWith('http://') || cleanUrl.startsWith('https://')) {
+    return cleanUrl;
+  }
+
+  // Absolute paths (public folder)
+  if (cleanUrl.startsWith('/')) {
+    return `${domain}${cleanUrl}`;
+  }
+
+  // Relative paths - resolve based on page path
+  if (cleanUrl.startsWith('./')) {
+    const relativePath = cleanUrl.slice(2); // Remove './'
+    const pageDir = pagePath.join('/');
+    return `${domain}/${pageDir}/${relativePath}`;
+  }
+
+  // Default case: treat as relative to page
+  const pageDir = pagePath.join('/');
+  return `${domain}/${pageDir}/${cleanUrl}`;
+}
+
 export async function generateMetadata(props: MetadataProps): Promise<Metadata> {
   const params = await props.params;
   const domain = isDeveloperDocs
     ? 'https://develop.sentry.dev'
     : 'https://docs.sentry.io';
-  // enable og iamge preview on preview deployments
+  // enable og image preview on preview deployments
   const previewDomain = process.env.VERCEL_URL
     ? `https://${process.env.VERCEL_URL}`
     : domain;
@@ -208,12 +243,8 @@ export async function generateMetadata(props: MetadataProps): Promise<Metadata>
   let customCanonicalTag: string = '';
   let description =
     'Self-hosted and cloud-based application performance monitoring & error tracking that helps software teams see clearer, solve quicker, and learn continuously.';
-  // show og image on the home page only
-  const images =
-    ((await props.params).path ?? []).length === 0
-      ? [{url: `${previewDomain ?? domain}/og.png`, width: 1200, height: 630}]
-      : [];
 
+  let ogImageUrl: string | null = null;
   let noindex: undefined | boolean = undefined;
 
   const rootNode = await getDocsRootNode();
@@ -236,9 +267,25 @@ export async function generateMetadata(props: MetadataProps): Promise<Metadata>
       }
 
       noindex = pageNode.frontmatter.noindex;
+
+      // Check for manual OG image override in frontmatter
+      if (pageNode.frontmatter.og_image) {
+        ogImageUrl = resolveOgImageUrl(
+          pageNode.frontmatter.og_image,
+          previewDomain ?? domain,
+          params.path
+        );
+      }
     }
   }
 
+  // Default fallback
+  if (!ogImageUrl) {
+    ogImageUrl = `${previewDomain ?? domain}/og.png`;
+  }
+
+  const images = [{url: ogImageUrl, width: 1200, height: 630}];
+
   const canonical = customCanonicalTag
     ? domain + customCanonicalTag
     : params.path

develop-docs/application-architecture/dynamic-sampling/architecture.mdx

@@ -1,6 +1,7 @@
 ---
 title: Architecture
 sidebar_order: 3
+og_image: /og-images/application-architecture-dynamic-sampling-architecture.png
 ---
 
 The architecture that powers Dynamic Sampling is composed of several components that work together to get the organization's sample rate closer to the target fidelity.

develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx

@@ -1,6 +1,7 @@
 ---
 title: Fidelity and Biases
 sidebar_order: 2
+og_image: /og-images/application-architecture-dynamic-sampling-fidelity-and-biases.png
 ---
 
 Dynamic Sampling allows Sentry to automatically adjust the amount of data retained based on how valuable the data is to the user. This is technically achieved by applying a **sample rate** to every event, which is determined by a **set of rules** that are evaluated for each event.

develop-docs/application-architecture/dynamic-sampling/index.mdx

@@ -1,7 +1,11 @@
 ---
 title: Dynamic Sampling
-description: Dynamic Sampling is a feature of the ingestion pipeline that allows Sentry to automatically adjust the amount of data retained based on the value of the data.
+description: >-
+  Dynamic Sampling is a feature of the ingestion pipeline that allows Sentry to
+  automatically adjust the amount of data retained based on the value of the
+  data.
 sidebar_order: 50
+og_image: /og-images/application-architecture-dynamic-sampling.png
 ---
 
 From all the data received by the SDKs, Sentry is able to extract low-granularity information through metrics, while Dynamic Sampling makes the decision of whether to keep or drop data.