hamid/baya-monorepo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc clean up phase 2

Browse Source
This commit is contained in:
hamid
2026-07-30 12:49:46 +03:30
parent c889c46110
commit c841bded26
36 changed files with 2970 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/contracts/README.md
+28 -1
View File
@@ -1,4 +1,29 @@
# Contracts — the shared interface between `client/` and `server/`
# Contracts — MOVED to `docs/integration/`
> ## ⛔ This folder is history. Do not read it as the contract.
>
> **The live client↔server contract is [`docs/integration/`](../../docs/integration/index.md).** Start at
> its [index.md](../../docs/integration/index.md) — the whole seam on one page — then open the one
> [domain file](../../docs/integration/domains/index.md) you need.
>
> | Was here | Now |
> | --- | --- |
> | `conventions/api-conventions.md` + `conventions/money-and-types.md` | [`docs/integration/api-contract.md`](../../docs/integration/api-contract.md) |
> | `domains/*.md` (17 files, named after backend phases) | [`docs/integration/domains/`](../../docs/integration/domains/index.md) (22 files, named after the client's `services/` domains) |
> | `openapi/swagger.v1.json` (2026-07-13) | [`docs/integration/openapi/`](../../docs/integration/openapi/README.md) (refreshed 2026-07-29) |
>
> Everything here was **frozen 2026-07-13** and has been superseded. It was audited against the live
> swagger during phase 2: the route-level content held up (no route named here is missing from the live
> API), but the body-casing rule, the server's local URL scheme, the envelope's field count and the enum
> vocabularies had all drifted. What changed and why:
> [domains/index.md § What replaced what](../../docs/integration/domains/index.md#what-replaced-what).
>
> Phase 6 archives this folder. Until then it stays readable **as a record**, not as an instruction.
---
<details>
<summary>The original README, kept for the record</summary>
The two projects are independent (no shared build). This folder is their **single shared source of
truth** for everything that crosses the wire: API routes, request/response shapes, status codes, enums,
@@ -43,3 +68,5 @@ shared flows, and money/format conventions. It lets a frontend agent build again
> Keep contracts **versioned by being honest**: when a shipped shape changes, update its `domains/*` doc
> and the OpenAPI snapshot in the same change, and call it out in the handoff so the frontend re-syncs.
</details>