Merge branch 'main' into DOCS-1006-visual-odometry-module

.github/workflows/docs.yml

@@ -28,19 +28,25 @@ jobs:
         uses: actions/configure-pages@v2
 
       - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2 
+        uses: peaceiris/actions-hugo@v2
         with:
           hugo-version: 'latest'
           extended: true
-          
+
       - name: Build
         run: make build-prod
-        
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
           path: ./public
 
+      - name: Upload tutorials search file
+        uses: actions/upload-artifact@v3
+        with:
+          name: tutorials-search-file
+          path: ./public/tutorials/typesense.json
+
   deploy:
     environment:
       name: github-pages
@@ -52,6 +58,23 @@ jobs:
         id: deployment
         uses: actions/deploy-pages@v1
 
+  upload-tutorials-page-entries:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'viamrobotics'
+    steps:
+      - name: Download the tutorials search file
+        uses: actions/download-artifact@v3
+        with:
+          name: tutorials-search-file
+      - name: Upload tutorials documents
+        run: |
+          jq -c '.[]' typesense.json > documents.jsonl
+          curl -H "X-TYPESENSE-API-KEY: ${{secrets.TYPESENSE_TUTORIALS_API_KEY}}" \
+          -X POST \
+          -T documents.jsonl \
+          "https://cgnvrk0xwyj9576lp-1.a1.typesense.net/collections/tutorials/documents/import?action=upsert"
+
   generate-index:
     needs: build
     if: github.repository_owner == 'viamrobotics'

.htmltest.yml

@@ -22,6 +22,7 @@ IgnoreURLs:
 - "slamtec.com"
 - "softroboticsinc.com"
 - "universal-robots.com"
+- "digikey.com"
 - "ufactory.cc"
 IgnoreDirs:
 - "lib"

README.md

@@ -10,7 +10,7 @@ To be able to build the docs locally, you need to install the following:
 - [`npm`](https://nodejs.org/en/download/)
 - Hugo
   - macOS/Linux: `brew install hugo`
-  - Windows: [https://gohugo.io/getting-started/installing/](https://nodejs.org/en/download/)
+  - Windows: [https://gohugo.io/getting-started/installing/](https://gohugo.io/getting-started/installing/)
 
 You can build the docs for local development using the following command:
 

assets/scss/_styles_project.scss

@@ -562,10 +562,12 @@ END MARKETING CSS
 .hover-card.tutorial {
   background-color: white;
   padding: 10px;
+  margin: 1rem 0.8rem 1rem 0.2rem;
 }
 
 .hover-card.tutorial > a {
   width: 100%;
+  text-decoration: none;
 }
 
 // Text is black
@@ -644,6 +646,11 @@ END MARKETING CSS
  font-weight: 400 !important;
 }
 
+.hover-card.tutorial * .pills > .pill.pill-highlight {
+  background-color: #000;
+  color: white;
+}
+
 .hover-card.tutorial * .pill.pill-lang {
   border-color: #00e8e8;
 }
@@ -1130,3 +1137,177 @@ ul.sectionlist > li:hover {
   padding: 0;
   font-size: 30px;
 }
+
+.td-sidebar__toggle {
+  float: right;
+}
+
+// Tutorials page start
+
+.search-panel__results.card-container {
+  max-width: 100%;
+}
+
+#tutorial-menu {
+  display: flex;
+  flex-direction: column;
+  max-width: 600px;
+}
+
+#tutorial-filters, #tutorial-filter-items {
+  display: flex;
+  flex-wrap: wrap;
+}
+
+#tutorial-filters > .filter {
+  text-decoration: none;
+  color: black;
+  padding: 0.2rem 1rem;
+  margin: 0.2rem;
+  border: 1px solid black;
+}
+
+.ais-Hits-item {
+  display: flex;
+}
+
+#hits .ais-Hits-list {
+  list-style-type: none;
+  display: flex;
+  flex-wrap: wrap;
+  width: 100%;
+}
+
+.search-panel__filters {
+  display: flex;
+}
+
+.search-facets {
+  width: 540px;
+  border: 1px solid black;
+  margin: 0.2rem;
+  padding: 0.2rem;
+  position: absolute;
+  z-index: 1;
+  background-color: white;
+}
+
+@media (max-width: 800px) {
+.search-facets {
+  max-width: 86%;
+  width: 445px;
+}
+}
+
+.search-facets > ul {
+  display: flex;
+  flex-wrap: wrap;
+  margin: 0.2rem;
+  padding: 0;
+}
+
+.search-facets * li {
+  list-style: none;
+  margin: 0.2rem
+}
+
+.search-facets * label {
+  margin: 0;
+}
+
+.search-facets * input {
+  padding: 0.1rem 0.25rem;
+  border: 1px solid black;
+  margin: 0.1rem;
+  font-size: 0.833rem !important;
+  font-weight: 400 !important;
+  line-height: 1.4375em;
+  background-color: whitesmoke;
+  color: black;
+  border-radius: 0px;
+  -moz-border-radius: 0px;
+}
+
+.search-facets * input.refined {
+  background-color: #000;
+  color: white;
+}
+
+#components-list * input,
+#services-list * input {
+  border-color: #a51aff;
+}
+
+#languages-list * input {
+  border-color: #00e8e8;
+}
+
+.ais-Hits-list {
+  padding: 0;
+}
+
+// Pagination CSS start
+
+#pagination {
+  margin: 2rem auto;
+}
+
+.ais-Pagination-item {
+  display: inline-block;
+}
+
+span.ais-Pagination-link {
+  background-color: #e7e5e4;
+}
+
+.ais-Pagination-item.ais-Pagination-item--selected > a.ais-Pagination-link {
+  background-color: #000;
+  color: white;
+}
+
+.ais-Pagination-link {
+  text-decoration: none;
+  color: black;
+  padding: 0.2rem 1rem;
+  margin: 0 0.2rem;
+  border: 1px solid black;
+}
+
+a.ais-Pagination-link:hover {
+  color: black;
+  background-color: #e7e5e4;
+}
+
+.ais-Pagination-list {
+  text-align: center;
+  padding: 0;
+}
+
+// Speed up bootstraps transition animations
+.search-facets.collapsing {
+  transition-duration: 0.000002s;
+}
+
+// Pagination CSS end
+
+// Tutorials page end
+
+// Search-autocomplete start
+
+.algolia-autocomplete {
+  flex-grow: 1;
+}
+
+// Search-autocomplete end
+
+// Make videos work without js
+
+.no-js * .lozad {
+  display: none;
+}
+
+// ensure tutorials page is 100% of height
+
+.row.flex-xl-nowrap {
+  min-height: 100%;
+}

config.toml

@@ -48,7 +48,13 @@ weight = 1
     codeFences = true
 
 [outputs]
-section = ["HTML"]
+section = ["HTML", "Typesense"]
+
+[outputFormats.Typesense]
+baseName = "typesense"
+isPlainText = true
+mediaType = "application/json"
+notAlternative = true
 
 [params]
 copyright = "Viam, Inc. - Documentation is licensed under Creative Commons ShareAlike License. "

docs/_index.md

@@ -44,9 +44,9 @@ sitemap:
       </a>
     </li>
     <li id="c1_slide5">
-      <a href="installation/prepare/sk-tda4vm/">
-        {{<imgproc src="installation/thumbnails/tda4vm.png" resize="148x120" declaredimensions=true alt="S K - T D A 4 V M">}}
-        <p>Texas Instruments TDA4VM</p>
+      <a href="components/board/upboard/">
+        {{<imgproc src="installation/thumbnails/up_4000.png" resize="148x120" declaredimensions=true alt="Intel Up board 4000">}}
+        <p>Intel UP4000</p>
       </a>
     </li>
     <li id="c1_slide6">
@@ -91,6 +91,12 @@ sitemap:
         <p>PCA9686 I<sup>2</sup>C Interface</p>
       </a>
     </li>
+    <li id="c1_slide13">
+      <a href="installation/prepare/sk-tda4vm/">
+        {{<imgproc src="installation/thumbnails/tda4vm.png" resize="148x120" declaredimensions=true alt="S K - T D A 4 V M">}}
+        <p>Texas Instruments TDA4VM</p>
+      </a>
+    </li>
   </ul>
   <ol style="visibility: hidden" aria-hidden="true">
     <li><a href="#c1_slide1">NVIDIA Jetson Nano</a></li>

docs/components/arm/fake.md

@@ -15,10 +15,9 @@ Configure a `fake` arm to test different models of robotic arms without any phys
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `fake` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `fake` model.
+Enter a name for your arm and click **Create**.
 
 ![An example configuration for a fake ur5e arm in the Viam app Config Builder.](/components/arm/fake-arm-ui-config.png)
 

docs/components/arm/ur5e.md

@@ -14,10 +14,9 @@ Configure a `ur5e` arm to add a [Universal Robots UR5e](https://www.universal-ro
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `ur5e` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `ur5e` model.
+Enter a name for your arm and click **Create**.
 
 ![Web UI configuration panel for an arm of model ur5e in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/ur5e-ui-config.png)
 

docs/components/arm/xarm6.md

@@ -15,10 +15,9 @@ Configure an `xArm6` arm to integrate a [UFACTORY xArm 6](https://www.ufactory.c
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `xArm6` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `xArm6` model.
+Enter a name for your arm and click **Create**.
 
 ![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArm6-ui-config.png)
 

docs/components/arm/xarm7.md

@@ -15,10 +15,9 @@ Configure an `xArm7` arm to integrate a [UFACTORY xArm 7](https://www.ufactory.c
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `xArm7` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `xArm7` model.
+Enter a name for your arm and click **Create**.
 
 ![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArm7-ui-config.png)
 

docs/components/arm/xarmlite.md

@@ -14,10 +14,9 @@ Configure an `xArmLite` arm to add a [UFACTORY Lite 6](https://www.ufactory.cc/p
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `xArmLite` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `xArmLite` model.
+Enter a name for your arm and click **Create**.
 
 ![Web UI configuration panel for an arm of model xArmLite in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArmLite-ui-config.png)
 

docs/components/arm/yahboom-dofbot.md

@@ -14,10 +14,9 @@ Configure a `yahboom-dofbot` arm to add a [Yahboom DOFBOT](https://category.yahb
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
-Click on the **Components** subtab and navigate to the **Create component** menu.
-Enter a name for your arm, select the type `arm`, and select the `yahboom-dofbot` model.
-
-Click **Create component**.
+Click on the **Components** subtab and click **Create component**.
+Select the `arm` type, then select the `yahboom-dofbot` model.
+Enter a name for your arm and click **Create**.
 
 ![Web UI configuration panel for an arm of model yahboom-dofbot in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/yahboom-dofbot-ui-config.png)