Skip to content

app-16292: add docs page for the Gizmos plugin#739

Open
Devin T. Currie (DTCurrie) wants to merge 24 commits into
app-16292/4-gizmos-pluginfrom
app-16292/5-gizmo-docs
Open

app-16292: add docs page for the Gizmos plugin#739
Devin T. Currie (DTCurrie) wants to merge 24 commits into
app-16292/4-gizmos-pluginfrom
app-16292/5-gizmo-docs

Conversation

@DTCurrie

@DTCurrie Devin T. Currie (DTCurrie) commented Jun 1, 2026

Copy link
Copy Markdown
Member

Adds a docs page covering the Gizmos plugin introduced in #738. Stacks on #738.

Stack

  1. Shared ECS traits and helpers (app-16292: shared ECS traits and helpers for entity pose plugins #735)
  2. Details refactor (app-16292: refactor Details panel into focused subcomponents #736)
  3. Component tweaks (app-16292: small component tweaks to support per-entity pose mutators #737)
  4. Gizmos plugin (app-16292: add Gizmos plugin #738)
  5. This PR: Gizmos plugin docs

Frontend

  • docs/src/content/docs/plugins/gizmos.mdx: new page documenting how to mount <Gizmos />, the available gizmo modes, the read / write properties on the useGizmos hook, and the marker traits exposed via gizmoTraits.
  • docs/astro.config.mjs: adds a <Gizmos /> sidebar entry under Plugins, alphabetized between <DrawService /> and <SelectionTool />.

Testing

Docs-only change. The deploy preview build will render the new Plugins > <Gizmos /> page and sidebar entry; no changeset since this does not change runtime behavior.

@changeset-bot

changeset-bot Bot commented Jun 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 25d79b6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Documents the dashboard tool added in the previous PR: how to mount
`<Gizmos />`, the available gizmo modes, the public `useGizmos` hook,
and the `gizmoTraits` namespace for queries against placed gizmos.
Sidebar entry alphabetized between DrawService and SelectionTool.
@DTCurrie

This comment was marked as outdated.

@claude

This comment was marked as outdated.

Comment thread docs/src/content/docs/plugins/gizmos.mdx Outdated
@DTCurrie

This comment was marked as outdated.

@claude

This comment was marked as outdated.

@DTCurrie

This comment was marked as outdated.

@claude

This comment was marked as outdated.

Comment thread docs/src/content/docs/plugins/gizmos.mdx
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://viamrobotics.github.io/visualization/pr-preview/pr-739/

Built to branch gh-pages at 2026-06-03 17:00 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@DTCurrie

This comment was marked as outdated.

@claude

This comment was marked as outdated.

Comment thread docs/src/content/docs/plugins/gizmos.mdx Outdated
Comment thread docs/src/content/docs/plugins/gizmos.mdx Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@DTCurrie

Copy link
Copy Markdown
Member Author

Claude (@claude) final review

@claude

claude Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Claude finished Devin T. Currie (@DTCurrie)'s task in 2m 10s —— View job


Final Review

  • Gather context and read changed files
  • Check previous review comments were addressed
  • Review current state of gizmos.mdx
  • Post final feedback

All three prior review issues are resolved:

Previous comment Status
exit() listed under "Read-only" table ✅ Moved to its own Methods section
No note about coordinate system / reference geometry lacking gizmoTraits entries <Aside> added
Reference plane / reference geometry field order mismatch with UI ✅ Both sections now match the UI order (placement mode → axis/shape/style)

One nit (inline comment filed on lines 159–161): the bullet list inside the <Aside> uses 4-space indentation. Standard Markdown treats 4 leading spaces as a code block, and MDX parsers typically apply the same rule inside JSX components — so the list may render as <pre> in the deploy preview. The fix is to dedent to 0 spaces; a one-click suggestion is attached inline. Worth a quick check in the deploy preview before merging.

Everything else — usage example, mode key table, per-tool step sequences, useGizmos API table, traits section, and sidebar entry — all match the source accurately. The docs page is otherwise ready to ship.
· Branch

Comment thread docs/src/content/docs/plugins/gizmos.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant