Skip to content

Regenerate SDK method docs from current SDKs (baseline, no mapping changes) - #5351

Merged
Jeremy Rose (jeremyrose-viam) merged 2 commits into
viamrobotics:mainfrom
jeremyrose-viam:sdk-scrape-baseline
Sep 24, 2026
Merged

Jeremy Rose (jeremyrose-viam) merged 2 commits into
viamrobotics:mainfrom
jeremyrose-viam:sdk-scrape-baseline

Conversation

@jeremyrose-viam

Copy link
Copy Markdown
Member

Runs update_sdk_methods.py against the current Go, Python (0.82.0), TypeScript, and Flutter SDK docs with no changes to sdk_protos_map.csv or 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:

  1. Regenerate SDK method docs — unmodified scraper output.
  2. Fix vale error and dead cartographer link via overrides — two one-line override changes; see below.

What the regeneration picks up

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, with no content or signature changes; this is a one-time reversion that won't recur.

Override fixes (commit 2)

  • Dead cartographer link: the link originates in overrides/methods/go.slam.Properties.Properties.return.md, so an unmodified regeneration puts it back. Removed it from the override.
  • Vale: the Python SDK's docstring for the new range parameter uses "e.g.", which fails Viam.AvoidObscure and would fail the vale check. Added python.app.get_robot_part_logs.range.md with 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 three Visibility parameter links in the app API (updateRegistryItem, listRegistryItems, updateModule) from Visibility to appApi. The parser fix is in a follow-up.

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 reports the same existing "unused" warnings as the weekly check-methods.yml run.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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 de530b7
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ab55d2a5cb2da0007cd7928
😎 Deploy Preview https://deploy-preview-5351--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: 35 (🔴 down 5 from production)
Accessibility: 99 (no change from production)
Best Practices: 100 (🟢 up 8 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
@jeremyrose-viam
Jeremy Rose (jeremyrose-viam) merged commit add241b into viamrobotics:main Sep 24, 2026
13 checks passed
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.

3 participants