remove download file from docs

Stevie-Ray · Oct 15, 2024 · 49c2c44 · 49c2c44
1 parent 6421b71
commit 49c2c44
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 50 deletions.
diff --git a/packages/docs/src/.vitepress/config.mts b/packages/docs/src/.vitepress/config.mts
@@ -50,7 +50,6 @@ export default defineConfig({
         text: "Core API",
         link: "/api/",
         items: [
-          { text: "Download", link: "/api/download" },
           { text: "IsActive", link: "/api/is-active" },
           { text: "IsDevice", link: "/api/is-device" },
           { text: "Tare", link: "/api/tare" },

diff --git a/packages/docs/src/api/download.md b/packages/docs/src/api/download.md
diff --git a/packages/docs/src/api/index.md b/packages/docs/src/api/index.md
@@ -1,6 +1,5 @@
 # Core API Reference
 
-- [Download](/api/download)
 - [IsActive](/api/is-active)
 - [IsDevice](/api/is-device)
 - [Tare](/api/tare)
diff --git a/packages/docs/src/api/is-active.md b/packages/docs/src/api/is-active.md
@@ -1,19 +1,19 @@
 ### Supported Devices
 
 ```ts
-import { Entralpi, Motherboard, Progressor, WHC06 } from "@hangtime/grip-connect"
+import { Entralpi, ForceBoard, Motherboard, Progressor, WHC06 } from "@hangtime/grip-connect"
 ```
 
 ### Basic Usage
 
 ```ts
-import { active, isActive, notify, Progressor } from "@hangtime/grip-connect"
+import { active, isActive, Progressor } from "@hangtime/grip-connect"
 
 const progressor = new Progressor()
 
 progressor.connect(
   // Listen for stream notifications
-  notify((data) => {
+  progressor.notify((data) => {
     // data: { massTotal: "0", massMax: "0", massAverage: "0", massLeft: "0", massCenter: "0", massRight: "0" }
 
     // Manually log the current activity status of the device

diff --git a/packages/docs/src/api/is-device.md b/packages/docs/src/api/is-device.md
@@ -17,7 +17,7 @@ progressor.connect(async () => {
    * @param {Device} [board] - The device to check.
    * @returns {boolean} - `true` if the device matches, otherwise `false`.
    */
-  if (isProgressor(board)) {
+  if (isProgressor(progressor)) {
     // Handle the Progressor device
   }
 })