diff --git a/docs/DB_SCHEMA.md b/docs/DB_SCHEMA.md index 5ef655e..0e8fe39 100644 --- a/docs/DB_SCHEMA.md +++ b/docs/DB_SCHEMA.md @@ -1,7 +1,7 @@ # DB Schema(新架構目標版) > 本文件是新架構的目標資料模型,供後端 schema 重建與 migration 依據。 -> DB 真實來源仍以 `backend/scripts/init_schema.sql` 為準。 +> DB 真實來源仍以 [backend/scripts/init_schema.sql](../backend/scripts/init_schema.sql) 為準。 ## 1) companies - `id` UUID PK default `gen_random_uuid()` diff --git a/docs/LOCAL_DEV_RUNBOOK.md b/docs/LOCAL_DEV_RUNBOOK.md index d88a242..36adc02 100644 --- a/docs/LOCAL_DEV_RUNBOOK.md +++ b/docs/LOCAL_DEV_RUNBOOK.md @@ -5,6 +5,8 @@ cd backend ./scripts/start_dev.sh ``` +- 專案路徑:[backend](../backend) +- 啟動腳本:[backend/scripts/start_dev.sh](../backend/scripts/start_dev.sh) ## 2) 啟動前端 ```bash @@ -12,8 +14,9 @@ cd frontend npm install npm run dev ``` +- 專案路徑:[frontend](../frontend) -## 3) 必要環境變數(backend/.env.development) +## 3) 必要環境變數([backend/.env.development](../backend/.env.development)) - `KEYCLOAK_BASE_URL` - `KEYCLOAK_REALM` - `KEYCLOAK_CLIENT_ID` diff --git a/docs/index.md b/docs/index.md index f266ba5..4057576 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,20 @@ # member.ose.tw 文件入口(新架構) ## 閱讀順序 -1. `docs/ARCHITECTURE.md` -2. `docs/DB_SCHEMA.md` -3. `docs/BACKEND_TASKPLAN.md` -4. `docs/FRONTEND_TASKPLAN.md` -5. `docs/FRONTEND_HANDOFF.md` -6. `docs/INTERNAL_API_HANDOFF.md` -7. `docs/LOCAL_DEV_RUNBOOK.md` +1. [docs/ARCHITECTURE.md](./ARCHITECTURE.md) +2. [docs/DB_SCHEMA.md](./DB_SCHEMA.md) +3. [docs/BACKEND_TASKPLAN.md](./BACKEND_TASKPLAN.md) +4. [docs/FRONTEND_TASKPLAN.md](./FRONTEND_TASKPLAN.md) +5. [docs/FRONTEND_HANDOFF.md](./FRONTEND_HANDOFF.md) +6. [docs/INTERNAL_API_HANDOFF.md](./INTERNAL_API_HANDOFF.md) +7. [docs/LOCAL_DEV_RUNBOOK.md](./LOCAL_DEV_RUNBOOK.md) ## 交辦順序(建議) -1. 先看 `ARCHITECTURE.md` 鎖定資料模型與權限模型。 -2. 再看 `DB_SCHEMA.md` 對齊 table/欄位/關聯。 -3. 後端依 `BACKEND_TASKPLAN.md` 執行 schema/API/Keycloak 同步調整。 -4. 前端依 `FRONTEND_TASKPLAN.md` + `FRONTEND_HANDOFF.md` 開工。 -5. 其他系統串接時看 `INTERNAL_API_HANDOFF.md`。 +1. 先看 [ARCHITECTURE.md](./ARCHITECTURE.md) 鎖定資料模型與權限模型。 +2. 再看 [DB_SCHEMA.md](./DB_SCHEMA.md) 對齊 table/欄位/關聯。 +3. 後端依 [BACKEND_TASKPLAN.md](./BACKEND_TASKPLAN.md) 執行 schema/API/Keycloak 同步調整。 +4. 前端依 [FRONTEND_TASKPLAN.md](./FRONTEND_TASKPLAN.md) + [FRONTEND_HANDOFF.md](./FRONTEND_HANDOFF.md) 開工。 +5. 其他系統串接時看 [INTERNAL_API_HANDOFF.md](./INTERNAL_API_HANDOFF.md)。 ## 目前狀態 - 架構定版:`Company -> Site`、`System -> Role`。 @@ -24,7 +24,7 @@ - API 白名單:保留 `api_clients`。 ## 單一真實來源 -- DB SQL:`backend/scripts/init_schema.sql` +- DB SQL:[backend/scripts/init_schema.sql](../backend/scripts/init_schema.sql) ## 文件邊界 - 本輪只保留可開發、可交辦、可驗收文件。