docs(error-handling): add error handling conventions doc (#630) - #718
Merged
Chucks1093 merged 1 commit intoJul 28, 2026
Merged
Conversation
…nk from state-management Adds docs/error-handling-conventions.md covering the five error display modes (toast, inline, section boundary, page boundary, transaction surfaces) plus the network mismatch banner overlay. Documents the ApiError.status cheat sheet, mutation patterns (network, server, validation, rejection), inline error state component usage, and how to extend the wallet/signature error classification (WALLET_ERROR_COPY) and the disabled-reason helper pattern (ClaimActionDisabledReasonKey). Cross-links from docs/state-management.md section 3 (Error Architecture Strategy) to the new conventions doc as required by issue accesslayerorg#630 acceptance criteria. Closes accesslayerorg#630
|
@omoh5 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds docs/error-handling-conventions.md, the single source of truth for how every error category is surfaced in the Access Layer client (toast, inline, section boundary, page boundary, transaction surfaces, network banner).
Also adds a cross-link from docs/state-management.md section 3 (Error Architecture Strategy) to the new conventions doc.
Closes #630.
Acceptance Criteria Coverage
Changes in this PR
Why now
Error handling across the client has been inconsistent — some pages use error boundaries, some handle query errors inline, and mutation errors are displayed differently depending on the component. This doc establishes a single decision flowchart (and per-mode reference) so every future component lands in the right bucket.
Cross-references inside the doc
Verification