docs(mobile,desktop): fix drifted command/config docs, document undocumented features - #500
Open
lessevv wants to merge 2 commits into
Open
docs(mobile,desktop): fix drifted command/config docs, document undocumented features#500lessevv wants to merge 2 commits into
lessevv wants to merge 2 commits into
Conversation
…on requirements Corrects several places where docs had drifted from the actual package source (verified against nativephp/mobile-air and nativephp/desktop): - open_browser's real default is false, not true (mobile config + native:jump guide) — the terminal already renders a scannable QR code. - status_bar_style isn't env()-wrapped in the real config; the docs implied an override env var that doesn't exist. - Environment setup listed PHP 8.3+/Laravel 11+; composer.json requires PHP 8.4+ and supports Laravel 10+. - native:install's option table had the --force/--fresh/--without-icu semantics backwards or fabricated: overwriting is actually the default, --no-force opts out, --without-icu doesn't exist, and --force actually means "re-download PHP binaries", not "overwrite". - native:run/native:jump were missing real options (--build=profileable, --browser). - Desktop's "Default Configuration File" reference had drifted significantly from the real config/nativephp.php: missing Azure Trusted Signing / Bifrost cleanup_env_keys entries, a completely different cleanup_exclude_files list, missing updater provider keys (autoupdate_token, public_url), and four undocumented top-level sections (queue_workers, prebuild/postbuild, nsis, binary_path). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Adds coverage for real, shipped features found with no docs home,
verified against nativephp/mobile-air and nativephp/desktop source:
- Mobile: MobileWallet facade (Apple Pay/Google Pay via Stripe) and its
three payment events, a Motion page for the shake-detection event,
an UpdateInstalled note on the versioning page, and a Bifrost
overview page (mobile build support is live; desktop's is marked
"coming soon" on Bifrost's own site, so it's mobile-only for now).
- Desktop: a Nightwatch integration page (auto-wired when both the
package and NIGHTWATCH_TOKEN are present), the missing
AutoUpdater::downloadUpdate() method and UpdateCancelled event, a
handful of Window/MenuBar/System methods that existed in the facades
but were never mentioned (Window::reload/unmaximize/position-by-id,
MenuBar::icon/contextMenu/showOnAllWorkspaces, System::printFile),
and a new Command Reference page mirroring mobile's.
- Bumped config('docs.released_versions.mobile.4') to include the
real 4.3.0/4.3.1 releases.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
Audited the docs against the actual nativephp/mobile-air and nativephp/desktop source and fixed what had drifted, then documented real shipped features that had no docs home. Every claim below was verified directly against the package source (methods, event constructors, config defaults) — see commit messages for specifics.
Fixes:
open_browser's real default isfalse, nottrue;status_bar_styleisn'tenv()-wrapped like the docs implied.native:install's option table had--force/--fresh/--without-icubackwards or fabricated — overwriting is the default,--no-forceopts out,--without-icudoesn't exist, and--forceactually means "re-download PHP binaries."native:run/native:jump/native:packagewere missing real options (--build=profileable,--browser,--ios/--android,--jump-by).cleanup_exclude_fileslist, missing updater keys, and four entirely undocumented config sections (queue_workers,prebuild/postbuild,nsis,binary_path).New documentation:
MobileWalletfacade (Apple Pay/Google Pay) + its payment events, a Motion page for shake detection, anUpdateInstallednote on the versioning page, a Bifrost overview page (mobile-only — desktop support is marked "coming soon" on Bifrost's own site), and a bump toreleased_versionsfor the real 4.3.0/4.3.1 releases.AutoUpdater::downloadUpdate()+ the missingUpdateCancelledevent, several undocumentedWindow/MenuBar/Systemmethods, and a new Command Reference page mirroring mobile's.🤖 Generated with Claude Code