--- description: Keep the public Website API docs pack in sync whenever storefront-facing backend APIs change. alwaysApply: true --- # Website API docs sync Whenever you add, change, or remove **storefront / website-facing** APIs (public `tenants/:host/...`, customer auth/addresses, cities, cart, orders, favorites), update the public docs pack in the **same change**. ## Files to keep in sync (both copies) 1. `docs/website-api/` — source of truth for humans / git 2. `src/website-docs/static/` — served by Nest at `/docs/website` (must match) Update as needed: | File | When | |------|------| | `openapi.json` | Paths, methods, params, bodies, or auth change | | `Meshkee-Website-API.postman_collection.json` | Same — add/rename/fix requests | | `AI_PROMPT.md` | Flow or hard rules change | | `index.html` | Hub copy / links (use **absolute** `/docs/website/...` hrefs, never `./`) | ## Rules - Docs are **domain-agnostic** (`YOUR_WEBSITE_DOMAIN` / `{domain}`), not tied to one business. - Do **not** document CMS/dashboard/super-admin routes in this pack. - After editing `docs/website-api/*`, copy the same files into `src/website-docs/static/`. - Prefer updating docs in the same PR/commit as the API change; don’t leave storefront contract drift.