Format docs

viamrobotics · Dec 2, 2024 · 78d9bef · 78d9bef
1 parent 2979eb9
commit 78d9bef
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 34 deletions.
diff --git a/docs/how-tos/control-motor.md b/docs/how-tos/control-motor.md
@@ -492,13 +492,13 @@ const main = async () => {
   const machine = await VIAM.createRobotClient({
     host,
     credentials: {
-      type: 'api-key'
-          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
-      payload: '<API-KEY>',
-      authEntity: '<API-KEY-ID>'
-      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+      // Replace "<API-KEY>" (including brackets) with your machine's api key
+      type: "api-key",
+      payload: "<API-KEY>",
+      // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+      authEntity: "<API-KEY-ID>",
     },
-    signalingAddress: 'https://app.viam.com:443',
+    signalingAddress: "https://app.viam.com:443",
   });
 
   button().onclick = async () => {

diff --git a/docs/how-tos/drive-rover.md b/docs/how-tos/drive-rover.md
@@ -521,13 +521,13 @@ async function main() {
   const machine = await VIAM.createRobotClient({
     host,
     credentials: {
-      type: 'api-key'
-          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
-      payload: '<API-KEY>',
-      authEntity: '<API-KEY-ID>'
-      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+      // Replace "<API-KEY>" (including brackets) with your machine's api key
+      type: "api-key",
+      payload: "<API-KEY>",
+      // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+      authEntity: "<API-KEY-ID>",
     },
-    signalingAddress: 'https://app.viam.com:443',
+    signalingAddress: "https://app.viam.com:443",
   });
 
   button().onclick = async () => {
@@ -1018,13 +1018,13 @@ const main = async () => {
   const machine = await VIAM.createRobotClient({
     host,
     credentials: {
-      type: 'api-key'
-          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
-      payload: '<API-KEY>',
-      authEntity: '<API-KEY-ID>'
-      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+      // Replace "<API-KEY>" (including brackets) with your machine's api key
+      type: "api-key",
+      payload: "<API-KEY>",
+      // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+      authEntity: "<API-KEY-ID>",
     },
-    signalingAddress: 'https://app.viam.com:443',
+    signalingAddress: "https://app.viam.com:443",
   });
 
   button().onclick = async () => {

diff --git a/docs/sdks/_index.md b/docs/sdks/_index.md
@@ -213,13 +213,13 @@ async function main() {
   const robot = await VIAM.createRobotClient({
     host,
     credentials: {
-      type: 'api-key'
-          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
-      payload: '<API-KEY>',
-      authEntity: '<API-KEY-ID>'
-      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+      // Replace "<API-KEY>" (including brackets) with your machine's api key
+      type: "api-key",
+      payload: "<API-KEY>",
+      // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+      authEntity: "<API-KEY-ID>",
     },
-    signalingAddress: 'https://app.viam.com:443',
+    signalingAddress: "https://app.viam.com:443",
   });
 
   console.log("Resources:");

diff --git a/docs/tutorials/control/air-quality-fleet.md b/docs/tutorials/control/air-quality-fleet.md
@@ -439,12 +439,12 @@ The following instructions describe how to set up an API key for one location.
     async function main() {
       const opts: VIAM.ViamClientOptions = {
         credentials: {
-          type: 'api-key'
-              /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
-          payload: '<API-KEY>',
-          authEntity: '<API-KEY-ID>'
-          /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
-        }
+          // Replace "<API-KEY>" (including brackets) with your machine's api key
+          type: "api-key",
+          payload: "<API-KEY>",
+          // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+          authEntity: "<API-KEY-ID>",
+        },
       };
 
       const orgID: string = "<ORGANIZATION ID>"; // Replace

diff --git a/static/include/program/authenticate.md b/static/include/program/authenticate.md
@@ -51,11 +51,11 @@ const host = "ADDRESS FROM THE VIAM APP";
 const robot = await VIAM.createRobotClient({
   host,
   credentials: {
-    type: 'api-key'
-        /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+    // Replace "<API-KEY>" (including brackets) with your machine's api key
+    type: 'api-key',
     payload: '<API-KEY>',
-    authEntity: '<API-KEY-ID>'
-    /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+    // Replace "<API-KEY-ID>" (including brackets) with your machine's api key id
+    authEntity: '<API-KEY-ID>',
   },
   signalingAddress: 'https://app.viam.com:443',
 });