guidestar

A reusable infrastructure for embedding interactive wireframe demos in Sphinx documentation and standalone HTML pages.

Any package can provide its own HTML wireframe and a list of demo steps. This package handles:

• Fetching and injecting the HTML into a container

• Overlaying play / pause / restart controls (Shadow DOM isolated)

• Stepping through actions (click, toggle-class, type-text, …) on a timer

• Pausing automatically when the user interacts with the demo

• Supporting multiple independent instances on the same page

Contents

• Quick Start
  • Installation
  • Minimal Sphinx example
  • Live example
  • Minimal standalone HTML example
• Configuration Reference
  • Config object
  • Step format
  • Supported actions
  • Custom actions
  • Captions (transcript overlay)
• Sphinx Directive
  • Basic syntax
  • Directive options
  • Using from an external package
  • Multiple instances
  • Adding captions
• Styling & Theming
  • Control button custom properties
  • Basic example
  • Scoping to light / dark themes
  • Repositioning the button
  • Making it circular
  • Customizing the highlight
  • Customizing the caption overlay
  • Full theming example
• Accessibility
  • Keyboard navigation
  • Focus indicators
  • Screen reader support
  • Reduced motion
  • WCAG 2.1 conformance summary
• Standalone HTML
  • Include the assets
  • Declarative usage
  • Programmatic usage
  • Dynamically loaded HTML
  • Full standalone example
• Embedding in Confluence
  • How it works
  • Setting up your project
  • Embedding in Confluence
  • Linking to the interactive version
  • Reusing wireframes with different steps
  • Demo config reference
  • Recording options
  • Troubleshooting
• CI Integration — Wireframe Review Action
  • Quick Setup
  • How It Works
  • Inputs
  • LLM Provider Setup
  • Explicit Configuration
  • Example: jdaviz
  • Analysis Scenarios
  • PR Comment Format
  • Applying Suggestions
  • Token Limits