Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion assets/scss/_sidebar-tree.scss
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ li .indent {
}

.ul-2 > li:not(:last-child) {
padding-bottom: 8px;
padding-bottom: 2px;
}
}

Expand Down
120 changes: 47 additions & 73 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,20 @@ h7,

.td-content > h3 {
margin-bottom: 0.667rem;
margin-top: 1.5rem;
}

// The float:left on ol > li::before creates floats that escape the ol's
// block formatting context. Since h3 has clear:both, it clears past those
// floats, creating an oversized gap. flow-root contains the floats in
// the ol's own BFC so they don't affect adjacent elements.
// Zero the last li's margin-bottom because flow-root prevents it from
// collapsing with the ol's margin, which would add unwanted extra space.
.td-content > ol {
display: flow-root;
}
.td-content > ol > li:last-child {
margin-bottom: 0;
}

/* END Adjust Heading sizes*/
Expand Down Expand Up @@ -3191,93 +3205,34 @@ nav {
background-color: rgb(232, 232, 234);
}

.second-nav {
min-width: 100%;
padding: 0.25rem 1rem;
border-top: 1px solid #e4e4e6;
border-bottom: 1px solid #e4e4e6;
}

.second-nav > ul {
padding: 0;
padding-left: 0.25rem;
margin: 0;
}

.second-nav > ul > li {
display: inline-block;
font-family:
"Public Sans",
-apple-system,
BlinkMacSystemFont,
"Segoe UI",
Roboto,
"Helvetica Neue",
Arial,
sans-serif,
"Apple Color Emoji",
"Segoe UI Emoji",
"Segoe UI Symbol";
font-size: 0.875rem;
line-height: 1.25rem;
margin: 5px 0px;
font-weight: 300;
}

.second-nav > ul > li > a {
color: #333;
padding: 5px 0.5rem;
margin-right: 0.5rem;
}

.second-nav > ul > li > a:hover,
.second-nav > ul > li > a.active-path {
text-decoration: none;
background-color: rgba(0, 0, 0, 0.03);
border-radius: 4px;
color: #282829;
font-weight: 500;
}

@media (min-width: 768px) {
.td-main main {
padding-top: 7.5rem;
padding-top: 5rem;
}
}

.td-navbar {
min-height: 3.5rem;
}

@media (max-width: 767px) {
.second-nav {
display: none;
}
}

@media (min-width: 992px) {
.d-lg-block {
display: flex !important;
}
}

span.section-overview {
display: none;
}

ul > li.nav-fold > span > span.link-and-toggle {
display: flex !important;
flex-direction: row;
}

ul > li.nav-fold:last-child {
ul.ul-0 > li.nav-fold:last-child {
padding-bottom: 0.5rem;
}

@media (min-width: 768px) {
.ul-1 > li.nav-fold.hide-if-desktop {
display: none;
}

#landing-page-sidebar {
display: none;
Expand All @@ -3290,24 +3245,38 @@ ul > li.nav-fold:last-child {

li.nav-fold.header-only > span > span {
color: #000000;
margin-top: 1rem;
margin-top: 0.25rem;
}

li.nav-fold.header-only:first-child > span > a {
margin-top: 0.5rem;
margin-top: 0.25rem;
}

li.nav-fold.header-only * li {
text-transform: unset;
}

li > span > ul.ul-2 {
padding-left: 0;
li.nav-top-section > span > span.link-and-toggle > a,
li.nav-top-section > a {
text-transform: uppercase;
font-size: 0.75rem;
letter-spacing: 0.05em;
font-weight: 600;
color: #666;
}

li.nav-top-section > span > ul.ul-2 {
margin-left: 0.5rem;
}

ul.ul-2 > li > span > span {
color: #282829;
font-weight: 600;
font-weight: 400;
font-size: 0.833rem;
}

ul.ul-2 > li > a {
font-size: 0.833rem;
}

li.header-only > span > ul.ul-3 {
Expand All @@ -3320,21 +3289,26 @@ ul > li.nav-fold:last-child {
padding-left: 0.5rem;
}

span.section-overview-title {
display: none;
}

.ul-1 > li.nav-fold > span > span.link-and-toggle {
display: none !important;
}

.td-sidebar-nav__section .ul-1 ul.ul-2 {
padding-left: 0;
padding-left: 0.5rem;
border-left: 1px solid #e4e4e6;
margin-left: 0.5rem;
}

.td-sidebar-nav__section ul.ul-1 {
margin-left: 0;
}

li.nav-top-section {
margin-bottom: 0.5rem;
border-bottom: 1px solid #e4e4e6;
}

li.nav-top-section:last-child {
border-bottom: none;
}
}

.menu-toggle {
Expand Down
4 changes: 2 additions & 2 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ breadcrumb_disable = false
footer_about_disable = false
navbar_logo = true
navbar_translucent_over_cover_disable = false
sidebar_menu_compact = true # When true, the section headings work like an accordian.
sidebar_menu_compact = true # When true, only the active path is expanded in the sidebar.
sidebar_search_disable = true
ul_show = 3 # Always expand every first level section of the sidenav -- due to tabs, our 'first level' is 3
ul_show = 1 # Show only top-level sections; deeper levels collapse unless active

[params.ui.feedback]
enable = true
Expand Down
9 changes: 9 additions & 0 deletions docs/build-modules/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Build and Deploy Modules"
title: "Build and Deploy Modules"
weight: 60
layout: "docs"
type: "docs"
no_list: true
description: "Understand the two kinds of modules, then write, test, and deploy your own."
---
9 changes: 9 additions & 0 deletions docs/build-modules/dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Access machine resources from within a module"
linkTitle: "Module dependencies"
weight: 36
layout: "docs"
type: "docs"
description: "From within a modular resource, you can access other machine resources using dependencies."
date: "2025-11-11"
---
9 changes: 9 additions & 0 deletions docs/build-modules/deploy-a-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Deploy a Module"
title: "Deploy a Module"
weight: 30
layout: "docs"
type: "docs"
description: "Package, upload, and distribute a module through the Viam registry."
date: "2025-01-30"
---
9 changes: 9 additions & 0 deletions docs/build-modules/from-hardware-to-logic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "What is a module?"
title: "What is a module?"
weight: 1
layout: "docs"
type: "docs"
description: "Understand the two kinds of modules and how configured hardware connects to application logic."
date: "2025-03-07"
---
17 changes: 17 additions & 0 deletions docs/build-modules/manage-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Update and manage modules you created"
linkTitle: "Update and manage modules"
type: "docs"
weight: 32
images: ["/registry/create-module.svg"]
icon: true
tags: ["modular resources", "components", "services", "registry"]
description: "Update or delete your existing modules, or change their privacy settings."
languages: []
viamresources: []
platformarea: ["registry"]
level: "Beginner"
date: "2024-06-30"
# updated: "" # When the tutorial was last entirely checked
cost: "0"
---
9 changes: 9 additions & 0 deletions docs/build-modules/module-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Module Reference"
title: "Module Developer Reference"
weight: 40
layout: "docs"
type: "docs"
description: "Reference for module developers: lifecycle, interfaces, meta.json schema, CLI commands, environment variables, and registry rules."
date: "2025-03-05"
---
9 changes: 9 additions & 0 deletions docs/build-modules/platform-apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Access platform APIs from within a module"
linkTitle: "Use platform APIs"
weight: 35
layout: "docs"
type: "docs"
description: "Write your validate and reconfigure functions to handle dependencies in your custom modular resource."
date: "2025-11-05"
---
17 changes: 17 additions & 0 deletions docs/build-modules/write-a-cpp-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Create a new module with C++"
linkTitle: "Create a C++ module"
type: "docs"
weight: 27
images: ["/registry/module-puzzle-piece.svg"]
tags: ["modular resources", "components", "services", "registry"]
description: "Add support for a new component or service model by writing a module in C++."
languages: ["c++"]
viamresources: []
platformarea: ["registry"]
level: "Intermediate"
date: "2024-07-30"
# updated: "" # When the tutorial was last entirely checked
cost: "0"
draft: true # Take out Go and Python, and check updatedness before un-drafting.
---
9 changes: 9 additions & 0 deletions docs/build-modules/write-a-driver-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Write a Driver Module"
title: "Write a Driver Module"
weight: 20
layout: "docs"
type: "docs"
description: "Build a module that implements a resource API and runs as a separate process."
date: "2025-01-30"
---
9 changes: 9 additions & 0 deletions docs/build-modules/write-a-logic-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Write a Logic Module"
title: "Write a Logic Module"
weight: 25
layout: "docs"
type: "docs"
description: "Build a module that monitors sensors, coordinates components, or runs automation logic."
date: "2025-03-06"
---
9 changes: 9 additions & 0 deletions docs/build-modules/write-an-inline-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Write an Inline Module"
title: "Write an Inline Module"
weight: 10
layout: "docs"
type: "docs"
description: "Write and deploy a custom module directly in the browser using Viam's inline module editor."
date: "2025-01-30"
---
1 change: 1 addition & 0 deletions docs/data-ai/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ linkTitle: "AI and Data"
title: "Work with Data and AI"
weight: 250
layout: "docs"
toc_hide: true
type: "docs"
no_list: true
noedit: true
Expand Down
9 changes: 9 additions & 0 deletions docs/data/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Manage data"
title: "Manage data"
weight: 40
layout: "docs"
type: "docs"
no_list: true
description: "Capture, query, filter, pipeline, export, and visualize data."
---
9 changes: 9 additions & 0 deletions docs/data/capture-sync/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Capture and sync"
title: "Capture and sync"
weight: 10
layout: "docs"
type: "docs"
no_list: true
description: "Capture data from your machines and sync it to the cloud."
---
12 changes: 12 additions & 0 deletions docs/data/capture-sync/advanced-data-capture-sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
linkTitle: "Advanced configuration"
title: "Advanced configuration"
tags: ["data management", "data", "services"]
weight: 10
layout: "docs"
type: "docs"
platformarea: ["data"]
description: "JSON-level configuration for retention policies, sync optimization, remote parts capture, and direct MongoDB capture."
date: "2025-02-10"
updated: "2025-12-04"
---
9 changes: 9 additions & 0 deletions docs/data/capture-sync/capture-and-sync-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Capture and sync data"
title: "Capture and sync data"
weight: 5
layout: "docs"
type: "docs"
description: "Capture data from any resource and sync it to the cloud."
date: "2025-01-30"
---
Loading
Loading