Skip to content

feat: [sc-125395] Add QOSS survey toast coach mark to Sphinx themes (XST + PST) - #117

Draft
derekokelly-rgb wants to merge 4 commits into
masterfrom
sc-125395-add-qoss-survey-toast-coach-mark-to-sphinx
Draft

feat: [sc-125395] Add QOSS survey toast coach mark to Sphinx themes (XST + PST)#117
derekokelly-rgb wants to merge 4 commits into
masterfrom
sc-125395-add-qoss-survey-toast-coach-mark-to-sphinx

Conversation

@derekokelly-rgb

Copy link
Copy Markdown

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

Copy link
Copy Markdown
Contributor

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name and GitHub username in the contributors section.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an optional, dismissible “toast” coach mark to the Xanadu Sphinx theme, intended to show a short prompt near the top of the page after a configurable delay (and only once per browser session).

Changes:

  • Introduces new theme options (coach_mark_enabled, coach_mark_toast) and documents their usage.
  • Adds a new coach_mark.html template included from layout.html, plus JS logic to show/dismiss/track the toast.
  • Adds CSS for the toast layout, styling, and entrance animation (with reduced-motion support).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
xanadu_sphinx_theme/theme.conf Adds new theme configuration knobs for enabling and configuring the coach mark toast.
xanadu_sphinx_theme/static/xanadu.css_t Adds styling and animations for the CoachMark toast component.
xanadu_sphinx_theme/layout.html Includes the new coach mark template and adds JS to position/show/dismiss/track the toast.
xanadu_sphinx_theme/coach_mark.html Adds the toast HTML template rendered conditionally based on theme options.
README.rst Documents the new configuration options and expected data shape.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread xanadu_sphinx_theme/layout.html Outdated
Comment thread xanadu_sphinx_theme/coach_mark.html
derekokelly-rgb and others added 2 commits July 28, 2026 16:00
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@derekokelly-rgb
derekokelly-rgb marked this pull request as draft July 30, 2026 15:29
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.

2 participants