Reference: add viam-server page with app-linked anchors#4971
Merged
shannonbradshaw merged 1 commit intoviamrobotics:mainfrom Apr 18, 2026
Merged
Reference: add viam-server page with app-linked anchors#4971shannonbradshaw merged 1 commit intoviamrobotics:mainfrom
shannonbradshaw merged 1 commit intoviamrobotics:mainfrom
Conversation
✅ 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
shannonbradshaw
force-pushed
the
viam-server-aliases
branch
from
e156ec2 to
a1dbebb
Compare
Copies existing viam-server content from operate/reference/viam-server/ to reference/viam-server.md. All aliases moved from reference/_index.md to the dedicated page. Body links updated to new-IA paths. The #maintenance-window anchor matches what the Viam app links to from the maintenance card and version-control documentation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
shannonbradshaw
force-pushed
the
viam-server-aliases
branch
from
c5e84c9 to
b9fda48
Compare
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
shannonbradshaw
added a commit
to shannonbradshaw/viam-docs
that referenced
this pull request
Apr 18, 2026
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>
5 tasks
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
New reference page at
reference/viam-server.mdcovering viam-server: communication, lifecycle (startup, reconfiguration, maintenance window, shutdown), logging configuration, CLI options, and installation. Content migrated fromoperate/reference/viam-server/_index.mdwith internal links updated to new-IA paths.App links this page catches
/operate/reference/viam-server/#maintenance-window/operate/reference/viam-server/#maintenance-window/operate/reference/viam-server//operate/reference/viam-server/Previously all four aliased to
reference/_index.md(catch-all with anchor loss). Now they land on the correct content with the correct#maintenance-windowanchor.Aliases moved from reference/_index.md
16 aliases moved from the catch-all to the dedicated page, covering all historical URL patterns for viam-server docs.
Internal link fixes
/manage/reference/viam-agent/→/reference/viam-agent//operate/modules/configure-modules/→/hardware/configure-hardware//operate/install/setup/→/foundation/Test plan
vale0 errorsmake build-prodclean🤖 Generated with Claude Code