Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format docs #3721

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Format docs #3721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/how-tos/control-motor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 () => {
Expand Down
24 changes: 12 additions & 12 deletions docs/how-tos/drive-rover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 () => {
Expand Down Expand Up @@ -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 () => {
Expand Down
12 changes: 6 additions & 6 deletions docs/sdks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:");
Expand Down
12 changes: 6 additions & 6 deletions docs/tutorials/control/air-quality-fleet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions static/include/program/authenticate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
});
Expand Down
Loading