Feat/write demo script#225
Merged
Merged
Conversation
Closed
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a structured demo script for ReturnHub and aligns it with the current Sprint 7 product flow.
Changes
docs/DEMO_SCRIPT.mdas a dedicated walkthrough guideseed_returnhub_demoRUNBOOK.mdfor deeper proof and verification commandsBehavior
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:
seed_returnhub_demo/ops/,/ops/{case_id}/, and/cases/{case_id}/docker compose exec -T web pytest -qdocker compose exec -T web python -m ruff check .docker compose exec -T web python -m black . --checkResult
The repository now includes a deterministic, presenter-friendly demo script that supports a short multi-surface walkthrough of the current ReturnHub application.
Notes
RUNBOOK.mdrather than replacing it