feat: update docs with new @guidepup/record package changes

Author: jlp-craigmorten

docs/api/class-guidepup-record.md

@@ -0,0 +1,43 @@
+---
+title: "Guidepup Record Library"
+---
+
+# Guidepup Record Library
+
+Guidepup Record provides tools for screen recording.
+
+Here's a typical example:
+
+```ts
+import { macOSRecord } from "@guidepup/record";
+
+(async () => {
+  // Start the screen recording.
+  const stopRecording = macOSRecord("./recordings/screenRecording.mov");
+
+  // ... perform some commands.
+
+  // Stop the screen recording.
+  stopRecording();
+})();
+```
+
+**Contents:**
+
+- [macOSRecord](./class-guidepup#guidepup-macos-record)
+- [windowsRecord](./class-guidepup#guidepup-windows-record)
+
+## macOSRecord {#guidepup-macos-record}
+
+**See:** [macOSRecord]
+
+Start a screen recording on MacOS.
+
+## windowsRecord {#guidepup-windows-record}
+
+**See:** [windowsRecord]
+
+Start a screen recording on Windows.
+
+[macosrecord]: ./class-macos-record "macOSRecord"
+[windowsrecord]: ./class-windows-record "windowsRecord"

docs/api/class-guidepup.md

@@ -37,7 +37,6 @@ import { voiceOver } from "@guidepup/guidepup";
 - [MacOSKeyCodes](./class-guidepup#guidepup-macos-key-codes)
 - [MacOSModifiers](./class-guidepup#guidepup-macos-modifiers)
 - [macOSQuit](./class-guidepup#guidepup-macos-quit)
-- [macOSRecord](./class-guidepup#guidepup-macos-record)
 - [nvda](./class-guidepup#guidepup-nvda)
 - [nvdaKeyCodeCommands](./class-guidepup#guidepup-nvda-key-code-commands)
 - [voiceOver](./class-guidepup#guidepup-voiceover)
@@ -46,7 +45,6 @@ import { voiceOver } from "@guidepup/guidepup";
 - [windowsOSActivate](./class-guidepup#guidepup-windows-activate)
 - [WindowsKeyCodes](./class-guidepup#guidepup-windows-key-codes)
 - [WindowsModifiers](./class-guidepup#guidepup-windows-modifiers)
-- [windowsRecord](./class-guidepup#guidepup-windows-record)
 - [windowsQuit](./class-guidepup#guidepup-windows-quit)
 
 ## macOSActivate {#guidepup-macos-activate}
@@ -79,12 +77,6 @@ Modifier keys for MacOS.
 
 Quits a MacOS application if running.
 
-## macOSRecord {#guidepup-macos-record}
-
-**See:** [macOSRecord]
-
-Start a screen recording.
-
 ## nvda {#guidepup-nvda}
 
 **Type:** [NVDA]
@@ -171,12 +163,6 @@ Key codes for Windows.
 
 Modifier keys for Windows.
 
-## windowsRecord {#guidepup-windows-record}
-
-**See:** [windowsRecord]
-
-Start a screen recording.
-
 ## windowsQuit {#guidepup-windows-quit}
 
 **See:** [windowsQuit]
@@ -188,7 +174,6 @@ Quits a Windows application if running.
 [macoskeycodes]: ./class-macos-key-codes "MacOSKeyCodes"
 [macosmodifiers]: ./class-macos-modifiers "MacOSModifiers"
 [macosquit]: ./class-macos-quit "macOSQuit"
-[macosrecord]: ./class-macos-record "macOSRecord"
 [nvda]: ./class-nvda "NVDA"
 [nvdakeycodecommands]: ./class-nvda-key-code-commands "NVDAKeyCodeCommands"
 [voiceover]: ./class-voiceover "VoiceOver"
@@ -197,5 +182,4 @@ Quits a Windows application if running.
 [windowsactivate]: ./class-windows-activate "windowsActivate"
 [windowskeycodes]: ./class-windows-key-codes "WindowsKeyCodes"
 [windowsmodifiers]: ./class-windows-modifiers "WindowsModifiers"
-[windowsrecord]: ./class-windows-record "windowsRecord"
 [windowsquit]: ./class-windows-quit "windowsQuit"

docs/api/class-macos-record.md

@@ -11,7 +11,7 @@ title: "macOSRecord"
 Start a screen recording on MacOS.
 
 ```ts
-import { macOSRecord } from "@guidepup/guidepup";
+import { macOSRecord } from "@guidepup/record";
 
 (async () => {
   // Start the screen recording.

docs/api/class-windows-record.md

@@ -11,7 +11,7 @@ title: "windowsRecord"
 Start a screen recording on Windows.
 
 ```ts
-import { windowsRecord } from "@guidepup/guidepup";
+import { windowsRecord } from "@guidepup/record";
 
 (async () => {
   // Start the screen recording.

package.json

@@ -31,17 +31,17 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.1",
-    "@docusaurus/preset-classic": "3.1.1",
+    "@docusaurus/core": "3.5.2",
+    "@docusaurus/preset-classic": "3.5.2",
     "@mdx-js/react": "^3.0.1",
     "clsx": "^2.1.0",
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "3.1.1",
-    "@guidepup/guidepup": "^0.22.3",
-    "@types/node": "^20.11.27"
+    "@docusaurus/types": "3.5.2",
+    "@guidepup/guidepup": "^0.24.0",
+    "@types/node": "^22.5.5"
   }
 }

sidebars.js

@@ -47,7 +47,6 @@ const sidebars = {
             { type: "doc", id: "api/class-macos-keystroke-command" },
             { type: "doc", id: "api/class-macos-modifiers" },
             { type: "doc", id: "api/class-macos-quit" },
-            { type: "doc", id: "api/class-macos-record" },
             { type: "doc", id: "api/class-nvda-key-code-commands" },
             { type: "doc", id: "api/class-nvda" },
             { type: "doc", id: "api/class-screenreader" },
@@ -59,12 +58,29 @@ const sidebars = {
             { type: "doc", id: "api/class-windows-key-codes" },
             { type: "doc", id: "api/class-windows-keystroke-command" },
             { type: "doc", id: "api/class-windows-modifiers" },
-            { type: "doc", id: "api/class-windows-record" },
             { type: "doc", id: "api/class-windows-quit" },
           ],
         },
       ],
     },
+    {
+      type: "category",
+      label: "Guidepup Record API Reference",
+      items: [
+        {
+          type: "doc",
+          id: "api/class-guidepup-record",
+        },
+        {
+          type: "category",
+          label: "Classes",
+          items: [
+            { type: "doc", id: "api/class-macos-record" },
+            { type: "doc", id: "api/class-windows-record" },
+          ],
+        },
+      ],
+    },
     {
       type: "category",
       label: "Virtual Screen Reader API Reference",