Repository navigation
Update navigation pages for the API rework in RDK v1.13.0 - #5447
Merged
Eliza Farley (elizafarley) merged 2 commits intoOct 21, 2026
Merged
Conversation
rdk#6643 (RSDK-14608), released in RDK v1.13.0, moves viam-server and the Go SDK to the reworked navigation API (api#917) and deletes the builtin navigation model. Python v0.85.0 and Flutter v0.23.0 ship the same API.
✅ 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
Contributor
Docs review: Ready to mergeThis PR adds a line to the existing Discontinued alert on both navigation pages, saying that RDK v1.13.0 removed the CI: All required checks passing (the Netlify header-rules and pages-changed checks were skipped) Docs health: No regressions Nits
Verified against source (7 claims)
Automated review by Claude. Rerunning the review updates this comment. |
TypeScript v0.77.0 still calls GetMode, SetMode and the other removed RPCs, which viam-server v1.13.0 and later don't serve.
Collaborator
Author
|
Fixed in 16a1aa1: the API page alert now adds "The TypeScript SDK still uses the API on this page, which Generated by Claude Code |
Eliza Farley (elizafarley)
approved these changes
Oct 21, 2026
Eliza Farley (elizafarley)
deleted the
claude/update-navigation-v1-13-removal
branch
October 21, 2026 14:50
|
🔎💬 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
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.
RDK v1.13.0 removes the
rdk:builtin:builtinnavigation model and replaces the navigation API that the two (discontinued, orphaned) navigation pages document. This PR adds that to each page's existing Discontinued alert, so a reader who follows the JSON template or callsSetModeon a currentviam-serverknows why it fails. It does not rewrite the pages.Source changes
services/navigation/builtin. In RDK v1.13.0 (git merge-base --is-ancestor e5e32c22b v1.13.0; v1.13.0 pinsgo.viam.com/apiv0.1.597).NavigationService. It has saved locations, routes and zones (Add/Get/List/Update/Delete each),NavigateToLocation,NavigateToPoint,NavigateRoute,PlanToPoint,PlanToLocation,ExecutePlan,GoToLocation,GoToPoint,Suspend,Resume,Cancel,GetPosition,GetNavigationStatus,GetPropertiesandGetCostmap.GetMode,SetMode,GetWaypoints,AddWaypoint,RemoveWaypoint,GetObstaclesandGetPathsare gone, andGetLocationreturns a saved location.Documents: no DOCS ticket found for RSDK-14608, APP-18273 or their parent RSDK-14607.
Docs changes
docs/reference/services/navigation/_index.md: the alert now saysviam-serverv1.13.0 and later no longer include therdk:builtin:builtinnavigation model the page configures.docs/reference/apis/services/navigation.md: the alert now says which versions replace the API, names the removed methods, and saysGetLocationreturns a saved location.Needs a human decision
The navigation API in viam-server, Go, Python and Flutter is now the location/route/zone API, but the docs only describe the old one, and
navigationis deliberately excluded fromsdk_protos_map.csv(docsCLAUDE.md). Documenting the new API, or removing these pages, depends on whether the navigation service is coming back. That decision is out of scope here.Not changed:
docs/monitor/default-interface.mdlists a "Navigation service" CONTROL card. The card comes from the external@viamrobotics/test-widgetspackage, which I couldn't check from source, so I didn't change the row.How I found these
service-api-xref.md→ navigation.navigation service,services/navigation,rdk:builtin:builtin,SetMode,waypointacrossdocs/,static/,data/,layouts/. The otherrdk:builtin:builtinmatches are the motion, data manager and base remote control services.connectivity.md,helmet.mdandcli/reference.mdmention the service only in passing.Checks
prettier (repo-local 3.2.5), markdownlint, vale,
frontmatter_rules.pyandmake build-prodpass.Generated by daily docs change agent
Generated by Claude Code