docs(code-push): add runtime error reference page#586
Closed
eseidel wants to merge 2 commits into
Closed
Conversation
Adds an operational reference for the runtime errors surfaced by the optional shorebird_code_push package, explaining what each error/exception means and what to do about it. Frames the content as ops documentation (you only see these via your own error reporting; Shorebird has no built-in crash reporting) and defers full API signatures to pub.dev. Cross-links the new page from the Troubleshooting page.
Contributor
Author
|
Closing in favor of fixing the root cause: the four-value |
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.
What
Adds a new page to the Code Push docs: Error Reference (
code-push/runtime-errors.mdx), explaining the runtime errors and exceptions most commonly reported by apps that use the optionalshorebird_code_pushpackage.This is the first reference-style page in the docs and the first page focused on the package's runtime behavior (the API itself remains documented on pub.dev).
Framing
Written as operational documentation, not an API reference:
shorebird_code_pushpackage is called out as optional (Shorebird patches automatically without it).code-push/(no new top-level section).Contents
UpdateException(<message>/<reason>), with a table ofUpdateFailureReasonvalues.noUpdate,Update already in progress), network/transient, device/environment, and patch-state.noUpdateguidance: it's obsolete — upgradeshorebird_code_pushto 2.0.6+.Verification
npm run build(astro check + build) passes with 0 errors / 0 warnings, and the internal-link validator reports all links valid.