Reference: add landing page#4974
Merged
shannonbradshaw merged 2 commits intoviamrobotics:mainfrom Apr 18, 2026
Merged
Conversation
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>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
htmltest caught a second `/foundation/` link at line 297 (alert tip linking to the set-up-a-machine section) that my earlier grep pass missed because the link text said "Set up a machine" but the target was still the legacy path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/reference/overview.mdwith a one-paragraph intro and a 9-row table mapping each subsection to what it's for (APIs, Components, Services, SDKs, viam-server, viam-agent, Triggers, Device setup, Glossary).docs/reference/_index.mdwithmanualLink: "/reference/overview/". All existing aliases preserved.Before this PR
/reference/rendered an empty page and the sidebar section header had nothing to click.Scope expansion (flagged)
docs/reference/viam-server.md(merged in #4971, before the foundation → set-up-a-machine rename in #4972) had a card linking to/foundation/. Hugo's card shortcode validates canonical URLs, not aliases, somake build-proderrored withCard has a bad link: /foundation. Updated the link to/set-up-a-machine/. Gap surfaced during verification, not introduced by this PR.Verification
Confirmed each of the nine destinations resolves (frontmatter inspection + build):
/reference/apis/,/reference/components/,/reference/services/,/reference/sdks/,/reference/viam-server/,/reference/viam-agent/,/reference/triggers/,/reference/device-setup/,/reference/glossary/Test plan
npx prettier --writecleanvale docs/reference/cleanmake build-prodclean/reference/,/reference/overview/, all 9 subsection URLs, and/set-up-a-machine/return 200 locally🤖 Generated with Claude Code