From 78d9befff7d1df20bfb3046d3b9c4d78e598f621 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Mon, 2 Dec 2024 17:25:54 +0100 Subject: [PATCH] Format docs --- docs/how-tos/control-motor.md | 12 +++++------ docs/how-tos/drive-rover.md | 24 ++++++++++----------- docs/sdks/_index.md | 12 +++++------ docs/tutorials/control/air-quality-fleet.md | 12 +++++------ static/include/program/authenticate.md | 8 +++---- 5 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/how-tos/control-motor.md b/docs/how-tos/control-motor.md index c83514d904..f37bc7456d 100644 --- 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 "" (including brackets) with your machine's api key */, - payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, + // Replace "" (including brackets) with your machine's api key + type: "api-key", + payload: "", + // Replace "" (including brackets) with your machine's api key id + authEntity: "", }, - 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 index 4d8d8ae8ab..d72a5d8211 100644 --- 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 "" (including brackets) with your machine's api key */, - payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, + // Replace "" (including brackets) with your machine's api key + type: "api-key", + payload: "", + // Replace "" (including brackets) with your machine's api key id + authEntity: "", }, - 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 "" (including brackets) with your machine's api key */, - payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, + // Replace "" (including brackets) with your machine's api key + type: "api-key", + payload: "", + // Replace "" (including brackets) with your machine's api key id + authEntity: "", }, - 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 index d108884428..3e09e5337f 100644 --- 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 "" (including brackets) with your machine's api key */, - payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, + // Replace "" (including brackets) with your machine's api key + type: "api-key", + payload: "", + // Replace "" (including brackets) with your machine's api key id + authEntity: "", }, - 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 index 10abab46a4..60fecdbce9 100644 --- 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 "" (including brackets) with your machine's api key */, - payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, - } + // Replace "" (including brackets) with your machine's api key + type: "api-key", + payload: "", + // Replace "" (including brackets) with your machine's api key id + authEntity: "", + }, }; const orgID: string = ""; // Replace diff --git a/static/include/program/authenticate.md b/static/include/program/authenticate.md index bfbe988385..7bef069aca 100644 --- 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 "" (including brackets) with your machine's api key */, + // Replace "" (including brackets) with your machine's api key + type: 'api-key', payload: '', - authEntity: '' - /* Replace "" (including brackets) with your machine's api key id */, + // Replace "" (including brackets) with your machine's api key id + authEntity: '', }, signalingAddress: 'https://app.viam.com:443', });