diff --git a/README.md b/README.md index f699e20..bc0d5a1 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,5 @@ Current state: design/specification only. No frontend scaffold or runtime code h - [`DESIGN.md`](DESIGN.md): visual language, interaction rules, responsive behavior, and current design-system state. - [`docs/DASHBOARD-SPEC.md`](docs/DASHBOARD-SPEC.md): draft product/UI requirements and acceptance criteria. +- [`docs/DASHBOARD-UX-SPEC.md`](docs/DASHBOARD-UX-SPEC.md): detailed screen map, RTL layouts, async states, data presentation, accessibility, and authorized export workflows. - [`AGENTS.md`](AGENTS.md): durable rules for future coding agents and contributors. - diff --git a/docs/DASHBOARD-SPEC.md b/docs/DASHBOARD-SPEC.md index a2fb277..f9134c3 100644 --- a/docs/DASHBOARD-SPEC.md +++ b/docs/DASHBOARD-SPEC.md @@ -4,6 +4,8 @@ - Capability: Merchant dashboard - Last updated: 2026-08-20 +Detailed screen-level behavior, representative layouts, content, accessibility, partial-delivery states, and export workflows are specified in [`DASHBOARD-UX-SPEC.md`](DASHBOARD-UX-SPEC.md). Both documents require explicit approval before implementation planning. + ## Objective Give a non-technical merchant a fast, trustworthy Persian RTL view of payment performance, problems, opportunities, and anonymized peer context, with every claim traceable to deterministic metrics. @@ -88,9 +90,17 @@ Give a non-technical merchant a fast, trustworthy Persian RTL view of payment pe - Production build passes type checking, linting, unit/component tests, and Playwright critical-flow tests. - No raw dataset record, payer-card key, credential, or AvalAI key enters client bundles/logging/storage. -## Unresolved dependencies +## Contract and implementation dependencies -- Approved analytics interface contract for the metric catalogue and cohort policy -- Approved authentication/session API -- OpenAPI/interface contract and error format -- Static adapter fallback/routing behavior under the final Nginx configuration +Resolved specification inputs: + +- Backend `ANALYTICS-SPEC.md` is approved, and the definitions in `METRIC-CATALOGUE.md` version `0.4.0` are authoritative. +- Backend `IDENTITY-SPEC.md` is approved for demo authentication, sessions, and tenant isolation. +- `DESIGN.md` version `0.3.2` approves the Git-tracked `static/fonts/IRANYekanXVFaNumVF.woff2` asset and adjacent `static/fonts/FontLicense.txt`. + +Still required before implementation: + +- Approved machine-readable analytics, identity, detail, SSE, error, and CSV export interface contracts. +- Product/interface approval for the exact CSV schema, encoding, filename, row cap, delivery, retention, and audit behavior. +- Static adapter fallback/routing behavior under the final Nginx configuration. +- Explicit approval of this capability spec and `DASHBOARD-UX-SPEC.md`.