Skip to content

Commit 3d49f33

Browse files
committed
DOCS-3760: Move to tablesteps for complex content
1 parent a605cee commit 3d49f33

File tree

4 files changed

+45
-7
lines changed

4 files changed

+45
-7
lines changed

assets/scss/_styles_project.scss

+37-1
Original file line numberDiff line numberDiff line change
@@ -553,8 +553,9 @@ details > div.expand-content > *:last-child {
553553
}
554554

555555
.expand {
556-
padding-bottom: 0.75rem;
557556
clear: both;
557+
margin-bottom: 0.75rem;
558+
margin-top: 0.75rem;
558559
}
559560

560561
.expand i {
@@ -1193,6 +1194,7 @@ td > ul, td > ol {
11931194
padding: .7rem 0;
11941195
background-color: white;
11951196
border-bottom: 1px solid rgb(215, 215, 217);
1197+
max-width: 1000px;
11961198
}
11971199

11981200
.horizontalheaders * .tab-content, .horizontalheaders > .tab-content {
@@ -3275,6 +3277,35 @@ li.active-path.tutorial-heading > a {
32753277
display: table-row;
32763278
}
32773279

3280+
.td-content > ol > li > p, .td-content > .table * ol > li > p,
3281+
.td-content * .table * ol > li > p,
3282+
.td-content > ol > li > .expand, .td-content > .table * ol > li > .expand,
3283+
.td-content > ol * li > .expand, .td-content * .table * ol > li > .expand,
3284+
.td-content > ol > li > div, .td-content > .table * ol > li > div,
3285+
.td-content * ol > li > div, .td-content * .table * ol > li > div,
3286+
.td-content > ol > li > picture, .td-content > .table * ol > li > picture,
3287+
.td-content * ol > li > picture, .td-content * .table * ol > li > picture,
3288+
.td-content > .table * ol > li > ul,
3289+
.td-content * ol > li > ul, .td-content * .table * ol > li > ul,
3290+
.td-content > ol > li > img, .td-content > .table * ol > li > img,
3291+
.td-content * ol > li > img, .td-content * .table * ol > li > img {
3292+
margin-left: 2.5rem;
3293+
}
3294+
3295+
.td-content > ol > li > ul {
3296+
margin-left: 1rem;
3297+
margin-bottom: 0.5rem;
3298+
}
3299+
3300+
.td-content * ul {
3301+
margin-left: 1rem;
3302+
padding-left: 0rem;
3303+
}
3304+
3305+
.td-content * ol * ul > li, .td-content > ol * ul > li {
3306+
margin-left: 1.5rem;
3307+
}
3308+
32783309
div.tablestep {
32793310
display: flex;
32803311
flex-direction: row;
@@ -3334,6 +3365,11 @@ div.tablestep > table td, div.tablestep table td {
33343365
margin-bottom: 0rem;
33353366
}
33363367

3368+
.td-content > ul li, .td-content > ol li {
3369+
list-style-position: outside;
3370+
margin-left: 1.0rem;
3371+
}
3372+
33373373
.td-content > ul {
33383374
padding-left: 1rem;
33393375
}

docs/data-ai/capture-data/conditional-sync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ On your machine's **CONFIGURE** tab, switch to **JSON** mode and add a `selectiv
236236

237237
{{% expand "Click to view a full configuration example" %}}
238238

239-
```json {class="line-numbers linkable-line-numbers" data-line="12-22,25-37,40-45"}
239+
```json {class="line-numbers linkable-line-numbers" data-line="12-21,25-37,40-45"}
240240
{
241241
"components": [
242242
{

docs/manage/fleet/provision/setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ For a guide you can give to end users for setting up their machine, see [Setup m
479479
{{< tabs >}}
480480
{{% tab name="Mobile app" min-height="703px" %}}
481481

482-
{{<video webm_src="/platform/provisioning-demo.webm" mp4_src="/platform/provisioning-demo.mp4" alt="Using the Viam mobile app to provision a new machine with viam-agent." poster="/platform/provisioning-demo.jpg" class="alignright" max-width="400px" style="margin-left: 2rem">}}
482+
{{<video webm_src="/platform/provisioning-demo.webm" mp4_src="/platform/provisioning-demo.mp4" alt="Using the Viam mobile app to provision a new machine with viam-agent." poster="/platform/provisioning-demo.jpg" class="" max-width="400px" style="margin-left: 2rem">}}
483483

484484
1. Open the app and follow any instructions there until the app directs you to turn on the machine.
485485

docs/operate/get-started/other-hardware/_index.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,10 @@ You can find details about the return types at [python.viam.dev](https://python.
202202

203203
{{< expand "Example code for a sensor module" >}}
204204

205+
The following code implements the sensor API by getting weather data from Open-Meteo and returning it using the `get_readings` function.
206+
207+
The `validate` and `reconfigure` functions have been edited so that the user can configure coordinates from which to get weather data, but if the user does not configure these optional attributes, defaults are assigned.
208+
205209
```python {class="line-numbers linkable-line-numbers"}
206210
import asyncio
207211
from typing import Any, ClassVar, Final, Mapping, Optional, Sequence
@@ -412,8 +416,6 @@ For each method you want to implement, replace the body of the method with your
412416
Make sure you return the correct type in accordance with the function's return signature.
413417
You can find details about the return types at [go.viam.com/rdk/components](https://pkg.go.dev/go.viam.com/rdk/components).
414418

415-
<ol><li style="counter-reset: item 5"><strong>Edit the methods you want to implement</strong>:
416-
417419
{{< expand "Example code for a camera module" >}}
418420
This example from [Hello World module](/operate/get-started/other-hardware/hello-world-module/) implements only one method of the camera API by returning a static image.
419421
It demonstrates a required configuration attribute (`image_path`) and an optional configuration attribute (`example_value`).
@@ -554,7 +556,7 @@ You can find more examples by looking at the source code GitHub repos linked fro
554556

555557
</li></ol>
556558

557-
<ol><li style="counter-reset: item 6"><strong>Add logging</strong> messages as desired.
559+
<ol><li style="counter-reset: item 5"><strong>Add logging</strong> messages as desired.
558560

559561
You can add log messages with various levels of severity:
560562

@@ -790,7 +792,7 @@ Configure any required attributes using proper JSON syntax.
790792
Click the **TEST** bar at the bottom of your modular component configuration, and check whether it works as expected.
791793
For example, if you created a sensor component, check whether readings are displayed.
792794

793-
{{<imgproc src="/how-tos/sensor-test.png" resize="x1100" declaredimensions=true alt="The test section of an example modular sensor, with readings displayed." style="width:600px" class="shadow" >}}
795+
{{<imgproc src="/how-tos/sensor-test.png" resize="x1100" declaredimensions=true alt="The test section of an example modular sensor, with readings displayed." style="max-width:600px" class="shadow" >}}
794796

795797
{{% /tablestep %}}
796798
{{% tablestep number=5 %}}

0 commit comments

Comments
 (0)