chore: update ref to docs (🤖) (#1109)

Co-authored-by: electron-website-docs-updater[bot] <166660481+electron-website-docs-updater[bot]@users.noreply.github.com>

Author: electron-website-docs-updater[bot]

docs/latest/.eslintrc.json

@@ -1 +1 @@
-7f51178371e9a3f4c098436ec3ef8a18316fad73
+51db52e1b56e0739944dfbc679a86f2c69a26e5f

docs/latest/.sha

@@ -0,0 +1,65 @@
+---
+title: "Electron Documentation Guide"
+description: "Guide: docs/development/api-history-migration-guide.md Style rules: docs/development/style-guide.md (see \"API History\" section) Schema: docs/api-history.schema.json Lint: npm run lint:api-history"
+slug: CLAUDE
+hide_title: false
+---
+
+# Electron Documentation Guide
+
+## API History Migration
+
+Guide: `docs/development/api-history-migration-guide.md`
+Style rules: `docs/development/style-guide.md` (see "API History" section)
+Schema: `docs/api-history.schema.json`
+Lint: `npm run lint:api-history`
+
+### Format
+
+Place YAML history block directly after the Markdown header, before parameters:
+
+````md
+### `module.method(args)`
+
+<!--
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/XXXXX
+```
+-->
+
+* `arg` type - Description.
+````
+
+### Finding when an API was added
+
+- `git log --all --reverse --oneline -S "methodName" -- docs/api/file.md` — find first commit adding a method name
+- `git log --reverse -L :FunctionName:path/to/source.cc` — trace C++ implementation history
+- `git log --grep="keyword" --oneline` — find merge commits referencing PRs
+- `gh pr view <number> --repo electron/electron --json baseRefName` — verify PR targets main (not a backport)
+- Always use the main-branch PR URL in history blocks, not backport PRs
+
+### Cross-referencing breaking changes
+
+- Search `docs/breaking-changes.md` for the API name to find deprecations/removals
+- Use `git blame` on the breaking-changes entry to find the associated PR
+- Add `breaking-changes-header` field using the heading ID from breaking-changes.md
+
+### Placement rules
+
+- Only add blocks to actual API entries (methods, events, properties with backtick signatures)
+- Do NOT add blocks to section headers like `## Methods`, `### Instance Methods`, `## Events`
+- Module-level blocks go after the `# moduleName` heading, before the module description quote
+- For changes affecting multiple APIs, add a block under each affected top-level heading (see style guide "Change affecting multiple APIs")
+
+### Key details
+
+- `added` and `deprecated` arrays have `maxItems: 1`; `changes` can have multiple items
+- `changes` entries require a `description` field; `added`/`deprecated` do not
+- Wrap descriptions in double quotes to avoid YAML parsing issues with special characters
+- Early Electron APIs (pre-2015) use merge-commit PRs (e.g., `Merge pull request #534`)
+- Very early APIs (2013-2014, e.g., `ipcMain.on`, `ipcRenderer.send`) predate GitHub PRs — skip history blocks for these
+- When multiple APIs were added in the same PR, they all reference the same PR URL
+- Promisification PRs (e.g., #17355) count as `changes` entries with a description
+  - These PRs are breaking changes and should have their notes as "This method now returns a Promise instead of using a callback function."
+- APIs that were deprecated and then removed from docs don't need history blocks (the removal is in `breaking-changes.md`)

docs/latest/CLAUDE.md

@@ -580,6 +580,10 @@ focus but may instead show a notification or flash the app icon (Wayland).
 
 You should seek to use the `steal` option as sparingly as possible.
 
+### `app.isActive()` _macOS_
+
+Returns `boolean` - `true` if the application is active (i.e. focused).
+
 ### `app.hide()` _macOS_
 
 Hides all application windows without minimizing them.
@@ -618,7 +622,11 @@ Returns `string` - The current application directory.
     by default is the `appData` directory appended with your app's name. By
     convention files storing user data should be written to this directory, and
     it is not recommended to write large files here because some environments
-    may backup this directory to cloud storage.
+    may backup this directory to cloud storage. It is recommended to store
+    app-specific files within a subdirectory of `userData` (e.g.,
+    `path.join(app.getPath('userData'), 'my-app-data')`) rather than directly
+    in `userData` itself, to avoid naming conflicts with Chromium's own
+    subdirectories (such as `Cache`, `GPUCache`, and `Local Storage`).
   * `sessionData` The directory for storing data generated by `Session`, such
     as localStorage, cookies, disk cache, downloaded dictionaries, network
     state, DevTools files. By default this points to `userData`. Chromium may

docs/latest/api/app.md

@@ -114,7 +114,7 @@ the response.
     cookie and will not be retained between sessions.
   * `sameSite` string (optional) - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy to apply to this cookie.  Can be `unspecified`, `no_restriction`, `lax` or `strict`.  Default is `lax`.
 
-Returns `Promise<void>` - A promise which resolves when the cookie has been set
+Returns `Promise<void>` - A promise which resolves when the cookie has been set.
 
 Sets a cookie with `details`.
 
@@ -123,16 +123,16 @@ Sets a cookie with `details`.
 * `url` string - The URL associated with the cookie.
 * `name` string - The name of cookie to remove.
 
-Returns `Promise<void>` - A promise which resolves when the cookie has been removed
+Returns `Promise<void>` - A promise which resolves when the cookie has been removed.
 
-Removes the cookies matching `url` and `name`
+Removes the cookies matching `url` and `name`.
 
 #### `cookies.flushStore()`
 
-Returns `Promise<void>` - A promise which resolves when the cookie store has been flushed
+Returns `Promise<void>` - A promise which resolves when the cookie store has been flushed.
 
-Writes any unwritten cookies data to disk
+Writes any unwritten cookies data to disk.
 
-Cookies written by any method will not be written to disk immediately, but will be written every 30 seconds or 512 operations
+Cookies written by any method will not be written to disk immediately, but will be written every 30 seconds or 512 operations.
 
 Calling this method can cause the cookie to be written to disk immediately.

docs/latest/api/cookies.md

@@ -62,6 +62,11 @@ The `globalShortcut` module has the following methods:
 
 ### `globalShortcut.register(accelerator, callback)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/534
+```
+
 * `accelerator` string - An [accelerator](../tutorial/keyboard-shortcuts.md#accelerators) shortcut.
 * `callback` Function
 
@@ -84,6 +89,11 @@ the app has been authorized as a [trusted accessibility client](https://develope
 
 ### `globalShortcut.registerAll(accelerators, callback)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/15542
+```
+
 * `accelerators` string[] - An array of [accelerator](../tutorial/keyboard-shortcuts.md#accelerators) shortcuts.
 * `callback` Function
 
@@ -103,6 +113,11 @@ the app has been authorized as a [trusted accessibility client](https://develope
 
 ### `globalShortcut.isRegistered(accelerator)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/534
+```
+
 * `accelerator` string - An [accelerator](../tutorial/keyboard-shortcuts.md#accelerators) shortcut.
 
 Returns `boolean` - Whether this application has registered `accelerator`.
@@ -113,10 +128,47 @@ don't want applications to fight for global shortcuts.
 
 ### `globalShortcut.unregister(accelerator)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/534
+```
+
 * `accelerator` string - An [accelerator](../tutorial/keyboard-shortcuts.md#accelerators) shortcut.
 
 Unregisters the global shortcut of `accelerator`.
 
 ### `globalShortcut.unregisterAll()`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/534
+```
+
 Unregisters all of the global shortcuts.
+
+### `globalShortcut.setSuspended(suspended)`
+
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/50425
+```
+
+* `suspended` boolean - Whether global shortcut handling should be suspended.
+
+Suspends or resumes global shortcut handling. When suspended, all registered
+global shortcuts will stop listening for key presses. When resumed, all
+previously registered shortcuts will begin listening again. New shortcut
+registrations will fail while handling is suspended.
+
+This can be useful when you want to temporarily allow the user to press key
+combinations without your application intercepting them, for example while
+displaying a UI to rebind shortcuts.
+
+### `globalShortcut.isSuspended()`
+
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/50425
+```
+
+Returns `boolean` - Whether global shortcut handling is currently suspended.

docs/latest/api/global-shortcut.md

@@ -42,6 +42,11 @@ webContentsView.webContents.loadURL('https://electronjs.org')
 
 ## Class: ImageView extends `View`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/46760
+```
+
 > A View that displays an image.
 
 Process: [Main](../glossary.md#main-process)
@@ -56,6 +61,11 @@ Process: [Main](../glossary.md#main-process)
 
 ### `new ImageView()` _Experimental_
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/46760
+```
+
 Creates an ImageView.
 
 ### Instance Methods
@@ -65,6 +75,11 @@ addition to those inherited from [View](view.md):
 
 #### `image.setImage(image)` _Experimental_
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/46760
+```
+
 * `image` NativeImage
 
 Sets the image for this `ImageView`. Note that only image formats supported by

docs/latest/api/image-view.md

@@ -1,12 +1,17 @@
 ---
 title: "inAppPurchase"
-description: "In-app purchases on Mac App Store."
+description: "YAML history added: - pr-url: https://github.com/electron/electron/pull/11292"
 slug: in-app-purchase
 hide_title: false
 ---
 
 # inAppPurchase
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/11292
+```
+
 > In-app purchases on Mac App Store.
 
 Process: [Main](../glossary.md#main-process)
@@ -17,6 +22,11 @@ The `inAppPurchase` module emits the following events:
 
 ### Event: 'transactions-updated'
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/11292
+```
+
 Returns:
 
 * `event` Event
@@ -30,6 +40,17 @@ The `inAppPurchase` module has the following methods:
 
 ### `inAppPurchase.purchaseProduct(productID[, opts])`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/11292
+changes:
+  - pr-url: https://github.com/electron/electron/pull/17355
+    description: "This method now returns a Promise instead of using a callback function."
+    breaking-changes-header: api-changed-callback-based-versions-of-promisified-apis
+  - pr-url: https://github.com/electron/electron/pull/35902
+    description: "Added `username` option to `opts` parameter."
+```
+
 * `productID` string
 * `opts` Integer | Object (optional) - If specified as an integer, defines the quantity.
   * `quantity` Integer (optional) - The number of items the user wants to purchase.
@@ -41,6 +62,15 @@ You should listen for the `transactions-updated` event as soon as possible and c
 
 ### `inAppPurchase.getProducts(productIDs)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/12464
+changes:
+  - pr-url: https://github.com/electron/electron/pull/17355
+    description: "This method now returns a Promise instead of using a callback function."
+    breaking-changes-header: api-changed-callback-based-versions-of-promisified-apis
+```
+
 * `productIDs` string[] - The identifiers of the products to get.
 
 Returns `Promise<Product[]>` - Resolves with an array of [`Product`](structures/product.md) objects.
@@ -49,24 +79,49 @@ Retrieves the product descriptions.
 
 ### `inAppPurchase.canMakePayments()`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/11292
+```
+
 Returns `boolean` - whether a user can make a payment.
 
 ### `inAppPurchase.restoreCompletedTransactions()`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/21461
+```
+
 Restores finished transactions. This method can be called either to install purchases on additional devices, or to restore purchases for an application that the user deleted and reinstalled.
 
 [The payment queue](https://developer.apple.com/documentation/storekit/skpaymentqueue?language=objc) delivers a new transaction for each previously completed transaction that can be restored. Each transaction includes a copy of the original transaction.
 
 ### `inAppPurchase.getReceiptURL()`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/11292
+```
+
 Returns `string` - the path to the receipt.
 
 ### `inAppPurchase.finishAllTransactions()`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/12464
+```
+
 Completes all pending transactions.
 
 ### `inAppPurchase.finishTransactionByDate(date)`
 
+```YAML history
+added:
+  - pr-url: https://github.com/electron/electron/pull/12464
+```
+
 * `date` string - The ISO formatted date of the transaction to finish.
 
 Completes the pending transactions corresponding to the date.