Skip to content

Commit e4ec622

Browse files
authored
DOCS-685: Use prettier linter (#1835)
1 parent 2c39245 commit e4ec622

File tree

232 files changed

+8772
-8387
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

232 files changed

+8772
-8387
lines changed

Diff for: .markdownlint.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ options:
88
MD010:
99
spaces_per_tab: 4
1010

11+
MD007:
12+
indent: 2
13+
1114
# MD013/line-length - Line length
1215
MD013: false
1316

@@ -25,3 +28,9 @@ MD041: false
2528

2629
# Code block style expect indented
2730
MD046: false
31+
32+
# Emphasis style
33+
MD049: "underscore"
34+
35+
# Space after list marker - needed for prettier linter
36+
MD030: false

Diff for: .prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"tabWidth": 2,
3+
"proseWrap": "preserve"
4+
}

Diff for: docs/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ hide_feedback: true
1010
sitemap:
1111
priority: 1.0
1212
---
13+
1314
<div class="max-page">
1415
<p>
1516
Welcome to the Viam Documentation!

Diff for: docs/appendix/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ weight: 90
55
simple_list: true
66
type: "docs"
77
description: "Reference and Background Material"
8-
---
8+
---

Diff for: docs/appendix/contribute.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ draft: true
66
type: "docs"
77
description: "A guide to viewing and contributing to Viam's open source efforts."
88
---
9+
910
## Coming soon
1011

1112
This page will contain information on:

Diff for: docs/appendix/glossary/api-namespace-triplet.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ aka:
88

99
Every Viam {{< glossary_tooltip term_id="resource" text="resource" >}} subtype exposes an [application programming interface (API)](https://en.wikipedia.org/wiki/API) to describe how you can interact with that resource.
1010

11-
These APIs are organized by colon-delimited-triplet identifiers, in the form of `namespace:type:subtype`.
11+
These APIs are organized by colon-delimited-triplet identifiers, in the form of `namespace:type:subtype`.
1212

13-
The `namespace` for built-in Viam resources is `rdk`, while the `type` is `component` or `service`.
14-
`subtype` refers to a specific component or service, like a `camera` or `vision`.
13+
The `namespace` for built-in Viam resources is `rdk`, while the `type` is `component` or `service`.
14+
`subtype` refers to a specific component or service, like a `camera` or `vision`.
1515

1616
One subtype can have various models, custom or built-in, but they all must conform to the subtype's API definition.
1717
This requirement ensures that when a resource of that model is deployed, you can [interface with it](/program/) using the same [client API methods](/program/apis/) you would when programming resources of the same subtype with a different model.

Diff for: docs/appendix/glossary/attribute.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ aka:
77
type: "page"
88
---
99

10-
A configuration parameter of a resource.
10+
A configuration parameter of a resource.

Diff for: docs/appendix/glossary/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ card:
99
name: reference
1010
weight: 10
1111
title: Glossary
12-
---
12+
---

Diff for: docs/appendix/glossary/model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ aka:
88

99
A particular implementation of a {{< glossary_tooltip term_id="resource" text="resource" >}} {{< glossary_tooltip term_id="subtype" text="subtype" >}}.
1010

11-
For example: `ur5e` is a *model* of arm, implementing the [resource API](/program/apis/) of the [arm](/components/arm/) subtype of {{< glossary_tooltip term_id="component" text="component" >}}, which, in turn, is a {{< glossary_tooltip term_id="type" text="type" >}} of resource.
11+
For example: `ur5e` is a _model_ of arm, implementing the [resource API](/program/apis/) of the [arm](/components/arm/) subtype of {{< glossary_tooltip term_id="component" text="component" >}}, which, in turn, is a {{< glossary_tooltip term_id="type" text="type" >}} of resource.

Diff for: docs/appendix/glossary/part.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ short_description: A single-board computer, desktop, laptop, or other computer r
66
aka:
77
---
88

9-
Robots are organized into *parts*, where each part represents a computer (a [single-board computer](/installation/), desktop, laptop, or other computer) running `viam-server`, the hardware {{< glossary_tooltip term_id="component" text="components" >}} attached to it, and any {{< glossary_tooltip term_id="service" text="services" >}} or other resources running on it.
9+
Robots are organized into _parts_, where each part represents a computer (a [single-board computer](/installation/), desktop, laptop, or other computer) running `viam-server`, the hardware {{< glossary_tooltip term_id="component" text="components" >}} attached to it, and any {{< glossary_tooltip term_id="service" text="services" >}} or other resources running on it.
1010

1111
For more information, see [Robot Architecture: Parts, Sub-Parts and Remotes](/manage/parts-and-remotes/).

Diff for: docs/appendix/glossary/robot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ short_description: An organizational concept, consisting of either one part, or
66
aka:
77
---
88

9-
An organizational concept, consisting of either one *{{< glossary_tooltip term_id="part" text="part" >}}*, or multiple *parts* working closely together to complete tasks.
9+
An organizational concept, consisting of either one _{{< glossary_tooltip term_id="part" text="part" >}}_, or multiple _parts_ working closely together to complete tasks.
1010

1111
For more information, see [Robots](../../manage/fleet/robots/).

Diff for: docs/appendix/glossary/type.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Type
33
id: type
44
full_link:
5-
short_description: Component and service are the built-in types of resource API the RDK provides.
5+
short_description: Component and service are the built-in types of resource API the RDK provides.
66
aka:
77
---
88

9-
In the {{< glossary_tooltip term_id="rdk" text="RDK" >}} architecture's {{< glossary_tooltip term_id="api-namespace-triplet" text="namespace triplet" >}} for resource APIs, *type* refers to the distinction between {{< glossary_tooltip term_id="component" text="component" >}} or {{< glossary_tooltip term_id="service" text="service" >}}.
9+
In the {{< glossary_tooltip term_id="rdk" text="RDK" >}} architecture's {{< glossary_tooltip term_id="api-namespace-triplet" text="namespace triplet" >}} for resource APIs, _type_ refers to the distinction between {{< glossary_tooltip term_id="component" text="component" >}} or {{< glossary_tooltip term_id="service" text="service" >}}.
1010

1111
However, the meaning of "type" can be context dependent across the Viam platform.
1212

Diff for: docs/appendix/glossary/viam-robot-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ The specification for communication with resources.
1313

1414
Currently, the Viam Robot API is defined in a collection of Protocol Buffer files.
1515

16-
All SDKs written by Viam use {{< glossary_tooltip term_id="grpc" text="gRPC" >}} but the Viam Robot API itself does not mandate gRPC as the transport mechanism.
16+
All SDKs written by Viam use {{< glossary_tooltip term_id="grpc" text="gRPC" >}} but the Viam Robot API itself does not mandate gRPC as the transport mechanism.

Diff for: docs/appendix/learning-resources.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: "A collection of links to external sources discussing robotics topi
55
type: "docs"
66
draft: true
77
---
8+
89
## Overview
910

1011
The following sections contain links that we think you will find useful during your journey into robotics.
@@ -68,7 +69,7 @@ And their values on a resistor:
6869

6970
- The bands 1 and 2 indicate the first two significant digits on a resistor.
7071
- Band 3 is a multiplier on four-band resistors.
71-
For example, a resistor with brown, green, orange bands representing, 1, 5, and 3, respectively, which equates to 15 times ten to the third, or 15,000 Ohms, or 15 kOhms.
72+
For example, a resistor with brown, green, orange bands representing, 1, 5, and 3, respectively, which equates to 15 times ten to the third, or 15,000 Ohms, or 15 kOhms.
7273
- On resistors with four bands, the band 4 indicates tolerance, with gold being +/- 5% and silver being +/- 10%.
7374
- On five-band resistors, band 3 becomes an additional significant digit, band 4 becomes the multiplier, and band 5 becomes the tolerance band.
7475
- Six-band resistors are read identically to five-band resistors, their difference being that the sixth band indicates the resistor's temperature coefficient.

0 commit comments

Comments
 (0)