Guide

PRC WP Admin Tours

Code-defined first-time tours in wp-admin, plus release-note splash overlays authored on the docs site. Domain plugins register spotlight copy and selectors. This plugin matches the current screen, runs the spotlight or the splash overlay, and stores progress per user.

Package: @prc/wp-admin-tours
Source: plugins/prc-wp-admin-tours/

Editors see a welcome splash on first login, then a short tour the first time they open a matching screen. They can skip either. They can start again from the command palette. Maintainers register spotlight tours from their own plugins. Release-note splashes are authored with a Splash Screen block on docs-site posts.

Choose a path

Who are you?

Start with the guide that matches your work.

Documentation

For editors

  • User guide — welcome splash, release-note overlays, first visit, skip, restart with Ctrl/Cmd+K

For maintainers

  • Architecture — register action, splash catalog, progress sum type, REST
  • Plugin README
  • PRC Email Builder — campaign first-visit tour
  • Requires plugin: prc-scripts. Domain plugins must not add Requires Plugins: prc-wp-admin-tours.

Was this helpful?