Skip to content

Regenerate SDK method docs; add arm manual mode/properties and ListRobotsForLocations - #5350

Closed
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
viamrobotics:mainfrom
jeremyrose-viam:sdk-scrape-2026-09-24
Closed

Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
viamrobotics:mainfrom
jeremyrose-viam:sdk-scrape-2026-09-24

Conversation

@jeremyrose-viam

Copy link
Copy Markdown
Member

Regenerates the SDK method reference docs with update_sdk_methods.py against the current Go, Python (0.82.0), TypeScript, and Flutter SDK docs.

New methods

Upstream SDK changes picked up

  • Python get_robot_part_logs gains order and range parameters. The SDK docstring for range uses "e.g.", which fails Viam.AvoidObscure, so there's a parameter override (python.app.get_robot_part_logs.range.md) with the same meaning in house style.
  • Flutter binaryDataByIds now takes a list of binary data ID strings rather than BinaryID objects.
  • Gripper, motion, and vision proto description overrides edited in Reference notes agents need: Move/GetPose names, vision frames and units, gripper holding #5301 are now reflected in the generated files.

Parser fixes

  • parse_typescript.py: TypeScript docs now render some parameter types namespace-qualified (for example, appApi.Visibility) as two links, and the parser took the first one, linking to the namespace page. It now skips namespace links to the actual type. This fixes Visibility (app), PowerMode (board), and Transform/PoseInFrame (robot).
  • The Go channel-parameter handling from DOCS-4801: Document arm MoveThroughJointPositionsStreamed for Go and C++ #5317 is now applied beyond arm: board StreamTicks renders as ch (chan Tick), and audio_out Play lists chunks (<-chan []byte) instead of a duplicated info parameter.

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. Because slam still 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; there are no content or signature changes. This is a one-time reversion that won't recur.
  • The dead cartographer link originates in overrides/methods/go.slam.Properties.Properties.return.md, so it would have come back on every regeneration. This PR removes it from the override so the fix sticks.

Checks

  • make build-prod passes.
  • vale 3.12.0 (CI's pinned version) reports 0 errors on all changed and added files.
  • The scraper's coverage mode still reports the existing, unrelated "unused" warnings (getGeometries across components, app Sequences, createOAuthAppUser, and others), same as the weekly check-methods.yml run.

🤖 Generated with Claude Code

…botsForLocations

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit fa3d745
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ab5644f6a8b420008834335
😎 Deploy Preview https://deploy-preview-5350--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🟢 up 4 from production)
Accessibility: 99 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants