| Document | What it covers |
|---|---|
| contributor-guide.md | Start here if you are new to the contracts codebase. Module layout, build commands, invoice lifecycle, bidding, escrow, KYC gates, error/event stability contracts, test auth pattern, WASM budget. |
| invoice-lifecycle.md | Full invoice state machine, transition table, investment status integration |
| DEFAULT_FLOW_DIAGRAM.md | State-machine diagram from invoice past-due → default → recovery; grace period, finality guards, dispute interception, and concrete timeline example |
| errors.md | Error code reference (stable integers) |
| events.md | Event schema and topic constants |
| security.md | Reentrancy guard, pause circuit breaker, access control |
| protocol-limits.md | Configurable numeric limits and string-length caps |
| fees.md | Fee management and revenue distribution |
| settlement.md | Settlement flows and partial payments |
| dispute.md | Dispute lifecycle and resolution |
| escrow.md | Escrow creation, release, and refund |
| bidding.md | Bid ranking, TTL, and cleanup |
| admin.md | Admin setup and transfer |
| storage-schema.md | Persistent storage keys and index layout |
| backup.md | Backup and restore |
| audit.md | Audit trail and hash chain |
| CROSS_INVOICE_ANALYTICS.md | Cross-invoice read patterns, supported entrypoints, and pagination bounds for contributors and integrators |
| UPGRADE_QUIESCE.md | How writes drain before a contract upgrade — maintenance mode, drain window, and operator checklist |
| OPERATIONAL_PLAYBOOKS.md | Protocol reasons, meaning, and operational playbooks |
| Document | What it covers |
|---|---|
| quicklendx-backend/docs/contributor-guide.md | Start here if you are new to the backend. Module layout, request pipeline, export/audit wiring, metrics, how to add an endpoint. |
| quicklendx-backend/docs/configuration.md | All environment variables with types, defaults, and production rules |
| quicklendx-backend/docs/exports.md | Export limits, streaming, formats, and integrity digest |
| quicklendx-backend/docs/observability.md | Prometheus metrics, Grafana queries, alert rules |
| quicklendx-backend/docs/testing.md | Contract testing, fixtures, and coverage requirements |
| Document | What it covers |
|---|---|
| EVENT_DASHBOARDS.md | Standard Grafana dashboards — panel URLs, PromQL queries, SQLite indexer queries, and alert rules for protocol health, event throughput, disputes, and settlement pipeline |
| MONITORING.md | Per-event alert thresholds for contract events |
| DASHBOARD_QUERIES.md | Full SQL reference for indexer health and workload queries |
| RUNBOOK_INCIDENT_RESPONSE.md | Step-by-step operator playbook for unexpected contract behavior |
See ux/ for component-level design specifications.
See security/ for KYC key handling and settlement security notes.