Repository navigation
Regenerate SDK method docs from current SDKs (baseline, no mapping changes) - #5351
Merged
Jeremy Rose (jeremyrose-viam) merged 2 commits intoSep 24, 2026
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Eliza Farley (elizafarley)
approved these changes
Sep 24, 2026
Jeremy Rose (jeremyrose-viam)
merged commit Sep 24, 2026
add241b
into
viamrobotics:main
13 checks passed
This was referenced Sep 24, 2026
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.

Runs
update_sdk_methods.pyagainst the current Go, Python (0.82.0), TypeScript, and Flutter SDK docs with no changes tosdk_protos_map.csvor the scraper, to establish a baseline. New method mappings and parser fixes will follow in separate PRs.Two commits, so they can be reviewed separately:
What the regeneration picks up
move_through_joint_positionsandget_3d_modelstabs. Their CSV mappings landed in Update arm docs for Python SDK move_through_joint_positions and get_3d_models #5284 without a regeneration.get_robot_part_logsgainsorderandrangeparameters.binaryDataByIdsnow takes a list of binary data ID strings rather thanBinaryIDobjects.StreamTicksrenders asch (chan Tick), and audio_outPlaylistschunks (<-chan []byte)instead of a duplicatedinfoparameter.About the slam.md diff
SLAM is semi-deprecated, so it may be surprising to see it change. None of this comes from SDK changes. #5191 restored slam.md as part of bringing SLAM back as an orphan page, and in the process the generated file was hand-formatted (prettier-style quotes and spacing) and a link to the removed
/reference/services/slam/cartographer/page was deleted by hand. Becauseslamstill has rows in the CSV, every scraper run regenerates this file and reverts those edits. The formatting changes are the scraper's normal output, matching every other generated file, with no content or signature changes; this is a one-time reversion that won't recur.Override fixes (commit 2)
overrides/methods/go.slam.Properties.Properties.return.md, so an unmodified regeneration puts it back. Removed it from the override.rangeparameter uses "e.g.", which failsViam.AvoidObscureand would fail the vale check. Addedpython.app.get_robot_part_logs.range.mdwith the same meaning in house style.Known issue left for a follow-up
The TypeScript docs now render some parameter types namespace-qualified (for example,
appApi.Visibility), and the TypeScript parser links to the namespace page instead of the type. This PR regresses threeVisibilityparameter links in the app API (updateRegistryItem,listRegistryItems,updateModule) fromVisibilitytoappApi. The parser fix is in a follow-up.Checks
make build-prodpasses.vale3.12.0 (CI's pinned version) reports 0 errors on all changed and added files.check-methods.ymlrun.🤖 Generated with Claude Code