On this page
Who this is forTeaching the new defaultCommon mistake to flag in reviewWhat NOT to teachFor Training
Who this is for
Engineers and contractors who open pull requests against the Dentolize repo. This is not end-user (clinic staff) training material โ there is nothing in the Dentolize product for clinic users to learn from this PR.
Teaching the new default
Walk a new contributor through this the first time they open a PR:
- Start a PR as normal. GitHub pre-fills the description from the
template โ the four usual questions, plus a new ## ๐งช Sandbox section near the bottom.
- Leave it alone if defaults are fine. The values shown
(two_regions: false, whatsapp: false, cron: true, seed: rich, env: IS_SANDBOX: "true") are exactly what every sandbox already used before this PR โ nothing to configure for a typical PR.
- Edit a value only when you need that specific thing. Common cases:
- Testing a WhatsApp template or webhook โ
whatsapp: true. - Testing multi-region behavior (only meaningful on branches with
packages/auth-server) โ two_regions: true.
- Iterating quickly without re-seeding a huge dataset each time โ
seed: basic.
- Testing something time-sensitive without a cron job interfering with
your fixture data โ cron: false.
- Passing a one-off environment variable into the server/queue/cron
containers โ add a key under env:.
- Save and wait. Opening the PR (or editing the description on an
existing one, if the Sandbox block's content changed) triggers an automatic redeploy. Progress and final URLs/credentials show up as a PR comment, usually within 10-30 minutes.
- Don't bother deleting the block if you don't need it. Leaving it as
the pre-filled default is equivalent to deleting it, other than the IS_SANDBOX=true env var โ see sandbox-settings-block.md.
Common mistake to flag in review
Editing the PR title or other parts of the description does not redeploy the sandbox by itself โ only a change to the Sandbox block's own content does. If someone edits whatsapp: false to whatsapp: true and rewords an unrelated paragraph in the same save, it still redeploys (body changed, block changed) โ but if they only reword the paragraph, it won't. This is expected, not a bug: see gate-and-deploy-flow.md.
What NOT to teach
Don't teach this as something that affects the live product for clinic users โ it's purely a preview-environment control. There's no analogous concept for clinic-facing training material.