docs(readme): surface the prebuilt-image flash flow and product doc links - #115
Merged
Conversation
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
1 participant
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 a "Flash a Prebuilt Image" section to the README ahead of the source build flow, plus per-product links to docs.arkelectron.com and the PAB Rev3 vs PAB_V3 disambiguation note.
Problem
The README only documents the source build/flash flow. The far simpler customer path — flashing a released package with
packaging/flash_from_package.sh, no build tools required — is only documented deep inpackaging/README.md, and the product docs never get linked from here.Solution
Lead with the prebuilt flow (three commands, recovery-mode note, link to packaging/README.md for details) and frame the existing Build & Flash section as the customize-from-source path. The product table now links each carrier's documentation.