Improve README example code accuracy and completeness#538
Merged
larryaasen merged 3 commits intomainfrom Feb 22, 2026
Merged
Conversation
…ix documentation errors Co-authored-by: larryaasen <325973+larryaasen@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add important examples to README code section
Fix and improve README example code
Feb 20, 2026
Co-authored-by: larryaasen <325973+larryaasen@users.noreply.github.com>
Copilot
AI
changed the title
Fix and improve README example code
Improve README example code accuracy and completeness
Feb 22, 2026
larryaasen
approved these changes
Feb 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the README documentation by fixing several inaccuracies and making code examples more complete and runnable. The changes address issues introduced in v12.0 and correct long-standing documentation errors.
Changes:
- Fixed README code examples to be complete and accurate, including proper initialization patterns
- Corrected
UpgraderStoreControllerdefault value documentation (swapped Fuchsia/iOS defaults) - Removed deprecated
upgraderDeviceparameter documentation (removed in v12.0)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #538 +/- ##
=======================================
Coverage 93.08% 93.08%
=======================================
Files 12 12
Lines 1287 1287
=======================================
Hits 1198 1198
Misses 89 89 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Several README examples were incomplete, inaccurate, or referenced APIs removed in v12.0, causing confusion for new users.
Changes
void main()withWidgetsFlutterBinding.ensureInitialized(); fixedconstusage throughoutupgraderDeviceparameter: Dropped fromUpgraderconstructor in v12.0 but still listed in docsUpgraderStoreControllerdefaults (swapped in docs vs. actual code):onFuchsia:UpgraderAppStore()→nulloniOS:null→UpgraderAppStore()osVersionwas referenced but never defined; replaced withVersion(0, 0, 0)placeholder and added comment pointing toexample/lib/main_appcast.dartfor the fulldevice_info_plus-based implementation; addedoniOSalongsideonAndroidosVersionwithVersion(0, 0, 0)dartlanguage tag to bare code fences; fixed missingconstin Go Router snippet✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.