Skip to content

Commit a35b29b

Browse files
Reference: add landing page; fix stale /foundation/ card link
Reference section previously had an empty _index.md with no landing content and no manualLink, so /reference/ rendered an empty page and the section header in the sidebar had nothing to click. Changes: - New overview.md with linkTitle "Overview", title "Reference", and a table of the section's nine subsections with one-line "use it for" blurbs (APIs, Components, Services, SDKs, viam-server, viam-agent, Triggers, Device setup, Glossary). - _index.md stubbed: kept all the legacy aliases, added manualLink to /reference/overview/. Scope expansion, flagged: - reference/viam-server.md (merged in PR viamrobotics#4971 before the foundation → set-up-a-machine rename in viamrobotics#4972) had a card linking to /foundation/, which is no longer a canonical URL. Hugo's card shortcode validates canonical URLs, not aliases, so the build errors with "Card has a bad link: /foundation". Updated the link to /set-up-a-machine/. This is a gap surfaced during verification while I was running make build-prod for the landing page, not anything I caused. Verified locally: make build-prod clean; /reference/, /reference/overview/, all nine subsection URLs, plus /set-up-a-machine/ all return 200. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 5a57cb0 commit a35b29b

3 files changed

Lines changed: 25 additions & 1 deletion

File tree

docs/reference/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ type: "docs"
77
no_list: true
88
noedit: true
99
open_on_desktop: true
10+
manualLink: "/reference/overview/"
1011
description: "Technical reference documentation for the Viam platform: APIs, SDKs, components, services, and more."
1112
aliases:
1213
- /reference/architecture/

docs/reference/overview.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
linkTitle: "Overview"
3+
title: "Reference"
4+
weight: 1
5+
layout: "docs"
6+
type: "docs"
7+
description: "Technical reference for the Viam platform: APIs, SDKs, built-in components and services, runtime behavior, supported hardware, and term definitions."
8+
date: "2026-04-18"
9+
---
10+
11+
Technical reference for the Viam platform. Use this section when you need authoritative details on APIs, built-in models, SDKs, runtime behavior, or supported hardware.
12+
13+
| Section | Use it for |
14+
| ---------------------------------------- | --------------------------------------------------------------------------------- |
15+
| [APIs](/reference/apis/) | Method reference for component, service, robot, and app APIs |
16+
| [Components](/reference/components/) | Per-model reference for built-in components: attributes, behavior, caveats |
17+
| [Services](/reference/services/) | Per-model reference for built-in services: attributes, behavior, caveats |
18+
| [SDKs](/reference/sdks/) | Python, Go, TypeScript, Flutter, and C++ SDK reference |
19+
| [viam-server](/reference/viam-server/) | viam-server runtime: lifecycle, configuration, logging, CLI options |
20+
| [viam-agent](/reference/viam-agent/) | viam-agent reference: subsystems, version control, system configuration |
21+
| [Triggers](/reference/triggers/) | Trigger configuration reference |
22+
| [Device setup](/reference/device-setup/) | Hardware-specific setup for supported single-board computers and microcontrollers |
23+
| [Glossary](/reference/glossary/) | Term definitions for the Viam platform |

docs/reference/viam-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,5 +476,5 @@ Note that this method may not work for versions that are too old, as Homebrew do
476476
{{< cards >}}
477477
{{% card link="/reference/apis/" %}}
478478
{{% card link="/hardware/configure-hardware/" %}}
479-
{{% card link="/foundation/" %}}
479+
{{% card link="/set-up-a-machine/" %}}
480480
{{< /cards >}}

0 commit comments

Comments
 (0)