Skip to content

docs: add volume-reset troubleshooting and fix emulator setup hints#32

Merged
jasonchen922 merged 1 commit into
mainfrom
users/jasonchen922/fix-emulator-setup-hints
Jul 1, 2026
Merged

docs: add volume-reset troubleshooting and fix emulator setup hints#32
jasonchen922 merged 1 commit into
mainfrom
users/jasonchen922/fix-emulator-setup-hints

Conversation

@jasonchen922

Copy link
Copy Markdown
Contributor

What

  • docs/quickstart.md: add a Troubleshooting entry — when a service stays unhealthy after an upgrade (e.g. container sico-backend is unhealthy), reset stale local Docker volumes with make compose-down-volumes, then make compose-up.
  • sandbox/emulator/setup/setup.sh: replace misleading ./setup.sh <cmd> runtime hints with the documented make emulator-* targets (bootstrap/start/stop/restart/logs/setup), so guidance is correct from the repo root where they are actually invoked.

Why

  • make emulator-setup runs the script from the repo root, but the script printed hints like ./setup.sh bootstrap that do not resolve there — confusing users into thinking the script is missing.
  • The "backend unhealthy" failure after pulling new code (stale MySQL volume) had no documented remedy.

Notes

  • Native-CLI usage/help block and script-only flags (--skip-mumu, help) intentionally kept as ./setup.sh (no make equivalent).
  • No new files; existing license headers untouched. bash -n on the script passes.

- quickstart: add troubleshooting row for resetting stale local Docker volumes (make compose-down-volumes) when a service stays unhealthy after an upgrade

- emulator/setup.sh: replace misleading ./setup.sh runtime hints with the documented make emulator-* targets; native-CLI usage block and script-only flags (--skip-mumu, help) left as-is
@jasonchen922 jasonchen922 merged commit 886136b into main Jul 1, 2026
6 of 7 checks passed
@jasonchen922 jasonchen922 deleted the users/jasonchen922/fix-emulator-setup-hints branch July 1, 2026 07:09
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.

1 participant