Skip to content

Render namespace-qualified TypeScript parameter types as TypeDoc shows them - #5352

Merged
Jeremy Rose (jeremyrose-viam) merged 5 commits into
viamrobotics:mainfrom
jeremyrose-viam:ts-qualified-param-types
Sep 25, 2026
Merged

Jeremy Rose (jeremyrose-viam) merged 5 commits into
viamrobotics:mainfrom
jeremyrose-viam:ts-qualified-param-types

Conversation

@jeremyrose-viam

@jeremyrose-viam Jeremy Rose (jeremyrose-viam) commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

The TypeScript SDK docs render some parameter types namespace-qualified, for example appApi.Visibility in listRegistryItems or boardApi.PowerMode in setPowerMode. TypeDoc emits these as two sibling links: one to the namespace page, one to the type.

parse_typescript.py took only the first tsd-signature-type element for a parameter's type, so for these parameters the generated docs linked to the namespace and dropped the type entirely:

The parser now keeps the namespace link, a ., and the type link, matching how TypeDoc displays the type and how our generated TypeScript return types already render. Unqualified types, which are the large majority, produce identical output.

Affected parameters

The regeneration touches 8 lines, all of this shape:

  • App: visibility / visibilities in updateRegistryItem, listRegistryItems, updateModule
  • Board: powerMode in setPowerMode
  • Robot: transforms in frameSystemConfig; source and supplementalTransforms in transformPose; supplementalTransforms in getPose

Checks

🤖 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>
…s them

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 71cfc16
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ab59fb4b93e640008f26e9e
😎 Deploy Preview https://deploy-preview-5352--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: 41 (🔴 down 6 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
…types

# Conflicts:
#	static/include/app/apis/generated/app.md
@jeremyrose-viam

Copy link
Copy Markdown
Member Author

Merged main in now that #5351 has landed. The one conflict was the three Visibility lines in app.md, which both #5351 and this PR changed; resolved to this PR's version, and a fresh regeneration produces no further diff. The PR now shows only the parser change and its 8 regenerated lines.

Copy link
Copy Markdown
Contributor

Verified against live ts.viam.dev: the App and Board parameters the new loop flags match the PR's list exactly (Robot checked from the diff only). Unqualified types are unaffected. LGTM.


Generated by Claude Code

@jeremyrose-viam
Jeremy Rose (jeremyrose-viam) merged commit 301b670 into viamrobotics:main Sep 25, 2026
12 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