For developers

This course teaches the product. The engineering documentation lives in the repository's docs/ folder: the PRD, the SRS, the SDS, the UX specification and the architecture decision records (ADRs). The root CLAUDE.md is the best single summary of how the code is organised.

Run the platform

Everything runs through the root Makefile. make help lists the targets.

make install     # uv sync (backend) + pnpm install (frontend)
make all         # Postgres + migrate + API on :8000 + web app on :5173

Load the demo

The Appendix A demo used throughout this course is built by a script:

cd backend
uv run python app/scripts/seed_demo_scenario.py --run

It creates the client Appendix A demo with the scenario Baseline: a 120 × 100 m shed, 12 m clear, a 12 × 10 m column grid; a Reserve storage zone and a Pick face filled with Selective 4 high racking; a receiving floor, a dispatch floor and a pack bench; three receiving doors and six dispatch doors; and a full set of operating profiles (the two-shift calendar, two inbound truck profiles, the Interstate order type and its outbound truck, two product groups, the receiving checks flow and six resource pools). --run also starts the baseline run, 7 days × 3 replications on seed 42 with racks 30 % full, and waits for it.

Open the project on the Projects page, then the scenario. docs/Demo_Script_MVP-S1.md is the twenty-minute presenter's script.

Run this site

The course is a VitePress site. It lives in the logicare-portal repository, in warehouse-studio-docs/, beside the portal it is deployed with.

cd warehouse-studio-docs
pnpm install
pnpm dev --port 5180   # the app's own dev server already uses :5173
pnpm build             # static site in .vitepress/dist
pnpm preview           # serve the built site

Deploy it

The site ships as an nginx image and as the warehouseStudioDocs component of the logicare-portal umbrella Helm chart.

# from warehouse-studio-docs/
docker build --platform linux/amd64 -t sandevdewthilina/logicare-warehouse-studio-docs:<version> .
docker push sandevdewthilina/logicare-warehouse-studio-docs:<version>

Then set warehouseStudioDocs.image.tag and the ingress hostname in the chart's values, and let Argo CD (or helm upgrade) roll it out. The container answers /healthz for its probes.

Where things are

Path	Holds
.vitepress/config.ts	The navigation and sidebar. The sidebar order is the teaching order.
.vitepress/theme/	The brand colours and figure styling.
start/, draw/, store/, run/, copilot/, deliver/	The six parts of the course.
reference/	The glossary, shortcuts, hierarchy, FAQ and this page.
public/screens/	Screenshots of the app, taken from the demo.
public/diagrams/	Hand-drawn SVG teaching diagrams.
Dockerfile, nginx.conf	The production image.

Writing a lesson

Each lesson follows the same shape: Why it matters, In plain words, In Warehouse Studio, Try it, and a Words you just learned box. Introduce a term before using it, and add it to the glossary. Quote button and field labels exactly as the app shows them, in bold.

When the app changes a label or a flow, update the lesson that teaches it and retake the screenshot from the demo at 1440 × 900.