Simplify the What is Viam? page#5078
Merged
shannonbradshaw merged 5 commits intoMay 28, 2026
Merged
Conversation
Restructure for readability: lead with the mental model, move the mechanics into a brief "How it works" section, and collapse the eight capability subsections (33 bullets) into a scannable list that links out to each section. Cut the redundant three-part opening, remove two em dashes, and refresh the page date. 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
- Component abstraction: each type has its own API (camera API, motor
API), not "one camera interface." Interface is the Go term; API is the
user-facing one (rdk/components/{camera,motor}).
- "Two programs" was wrong: viam-server runs each module as a separate
process, so a machine runs agent + server + one process per module
(rdk/module/modmanager). Drop the count.
- A driver is itself a module, so "drivers and modules" coordinated a
subset with its superset. Reword to "modules, including drivers."
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drop the abstract "every model of that type implements it" clause (redundant with the examples that follow, and "model" is undefined here and collides with "machine learning models" below). Use parallel ellipsis so "implements" appears once, not three times. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Use upstream main's introduction and "Viam fundamentals" section as-is, and replace the H3 subsections under "Viam capabilities" with the simplified eight-bullet list that links out to each section. 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.
Restructures the What is Viam? page so a newcomer can build a mental model before hitting the mechanics, then corrects accuracy and prose. The page goes from ~171 lines to ~60.
Restructure
viam-agentinstalls and supervisesviam-server;viam-serverpulls config and modules), and moved the architecture diagram here where it has context.Accuracy pass
Verified the runtime claims against rdk/api code and the registry:
rdk:component:camera,rdk:component:motor), so the page now says every camera implements the camera API, every motor the motor API, rather than "one camera interface."viam-serverspawns each module as a separate process (rdk/module/modmanager), so a real machine runs agent + server + one process per module.Writing pass
Reviewed top-down against the writing playbook (Williams/LRS). One edit: tightened the component-API sentence so "implements" appears once instead of three times, and dropped an undefined "model" that collided with "machine learning models" later on.
Checks
prettier, vale, and
make build-prodall pass (933 pages, no errors). markdownlint runs in CI.One judgment call: "Develop code remotely" had no section to link to (
/dev/redirects to this page), so it points at/reference/sdks/.🤖 Generated with Claude Code