starcoach-hackathon/zarinpal-analytics-frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(spec): link dashboard UX contract

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:05:53 +03:30
parent 1b7c51a2f4
commit ce596b97c4
2 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -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. - [`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-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. - [`AGENTS.md`](AGENTS.md): durable rules for future coding agents and contributors.

20
docs/DASHBOARD-SPEC.md
View File

@@ -4,6 +4,8 @@
- Capability: Merchant dashboard - Capability: Merchant dashboard
- Last updated: 2026-08-20 - 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 ## 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. 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. - 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. - 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 Resolved specification inputs:
- Approved authentication/session API
- OpenAPI/interface contract and error format - Backend `ANALYTICS-SPEC.md` is approved, and the definitions in `METRIC-CATALOGUE.md` version `0.4.0` are authoritative.
- Static adapter fallback/routing behavior under the final Nginx configuration - 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`.