Skip to content

sanity-labs/add-studio-tour

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

add-studio-tour

Guided product tours for Sanity Studio, packaged as a standalone Claude Code plugin. It installs and wires sanity-plugin-studio-tour into an existing Studio: vendors the plugin, adds tourPlugin to the chosen workspaces, patches the desk structure so the Guided Tour type is browsable, authors a starter tour, and verifies selectors against the running Studio.

The plugin code ships vendored inside the skill (skills/add-studio-tour/vendor/studio-tour; the exact version is stamped in that folder's VERSION file), so each Studio that installs the skill gets its own copy to adapt — no central runtime dependency to version or maintain.

What is a Studio tour?

A Studio tour is a guided, step-by-step walkthrough that runs inside Sanity Studio. Each tour is an ordered set of steps; every step points at a real element of the Studio UI (via a CSS selector) and shows a small popover with a title and a rich-text description (bold, links, lists). Editors advance through the steps to learn where things live and how a workflow is meant to be done — onboarding, feature announcements, or "how we use this Studio" guidance — without leaving the app.

Tours are authored as content: a Guided Tour document type lives in your dataset, so non-developers can write, reorder, and publish steps from the Studio itself. Only published tours appear to editors.

Note

A step's selector is what anchors the popover to the UI. If the Studio layout changes, re-verify selectors so steps don't point at the wrong (or a missing) element.

What it looks like

Studio Tour Selector Screenshot 2026-06-30 at 16 53 15 Studio Tour Step Screenshot 2026-06-30 at 16 53 34 Studio Tour Dashboard Screenshot 2026-06-30 at 16 54 18

Install

# add this repo as a marketplace, then install the plugin
claude plugin marketplace add sanity-labs/add-studio-tour
claude plugin install add-studio-tour@studio-tour
# restart Claude Code — skills load on the next session

Then run the skill (/add-studio-tour) in a project that has a Sanity Studio.

Update

claude plugin marketplace update studio-tour
claude plugin update add-studio-tour@studio-tour   # restart to apply

Layout

.
├── .claude-plugin/marketplace.json   # marketplace manifest (name: "studio-tour")
└── add-studio-tour/                  # the plugin (name: "add-studio-tour")
    ├── .claude-plugin/plugin.json
    └── skills/
        └── add-studio-tour/          # the skill — SKILL.md + vendored plugin tree

Notes

  • Private vs public: if this repo is private under sanity-labs, org members install over SSH exactly as above; make it public for anyone to install.
  • Canonical source: the vendored code mirrors the upstream sanity-plugin-studio-tour package; the skill's scripts/sync_vendor.sh re-syncs it.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages