Skip to content

Feat/write demo script#225

Merged
AAdewunmi merged 3 commits into
mainfrom
feat/write-demo-script
Apr 22, 2026
Merged

Feat/write demo script#225
AAdewunmi merged 3 commits into
mainfrom
feat/write-demo-script

Conversation

@AAdewunmi

Copy link
Copy Markdown
Owner

Summary

Adds a structured demo script for ReturnHub and aligns it with the current Sprint 7 product flow.

Changes

  • added docs/DEMO_SCRIPT.md as a dedicated walkthrough guide
  • aligned the script with the repo’s current Docker-based setup and seeded demo workflow
  • replaced obsolete setup references with seed_returnhub_demo
  • documented the current public, console, ops, shared case-detail, and API surfaces used in the demo
  • added deterministic case-pick commands for selecting the main ops case and shared case-detail case
  • assigned specific seeded users to each part of the walkthrough
  • replaced placeholder case references with concrete demo variables
  • added a suggested pacing section to keep the walkthrough within five to eight minutes
  • linked the script back to RUNBOOK.md for deeper proof and verification commands

Behavior

The demo script now provides a repeatable walkthrough of the live product using the current seeded environment. It tells the presenter which users to log in as, which case IDs to use, which routes to open, and what to say during each step.

Why

This makes the demo easier to run consistently during reviews, walkthroughs, or interviews. It reduces presenter guesswork, removes stale commands, and ensures the script reflects the actual project rather than an outdated or partial draft.

Validation

The script was aligned against the repository’s current documented flow, including:

  • Docker-based app startup
  • seed_returnhub_demo
  • seeded users and shared demo password
  • current UI routes such as /ops/, /ops/{case_id}/, and /cases/{case_id}/
  • current validation commands:
    • docker compose exec -T web pytest -q
    • docker compose exec -T web python -m ruff check .
    • docker compose exec -T web python -m black . --check

Result

The repository now includes a deterministic, presenter-friendly demo script that supports a short multi-surface walkthrough of the current ReturnHub application.

Notes

  • this change adds documentation only
  • no runtime behavior, CI configuration, or app code was changed
  • the script complements RUNBOOK.md rather than replacing it

@AAdewunmi AAdewunmi self-assigned this Apr 22, 2026
@AAdewunmi AAdewunmi added the sprint-7-docs-ux-ci Write demo script label Apr 22, 2026
@AAdewunmi AAdewunmi linked an issue Apr 22, 2026 that may be closed by this pull request
@codecov

codecov Bot commented Apr 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AAdewunmi AAdewunmi merged commit 61b3b80 into main Apr 22, 2026
3 checks passed
@AAdewunmi AAdewunmi deleted the feat/write-demo-script branch April 22, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sprint-7-docs-ux-ci Write demo script

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

Write demo script

1 participant