Add mobile 2.x documentation and version switcher #228
Conversation
Introduces comprehensive documentation for the mobile 2.x platform, including API references (biometrics, browser, camera, device, dialog, geolocation, haptics, push notifications, QR code, secure storage, system), concepts (CI/CD, databases, deep links, push notifications, security), and EDGE components (bottom nav, FAB, side nav, top bar). Also updates the docs index view to support a version switcher for the mobile platform.
Tables that overflow their container now display with horizontal scroll instead of breaking the layout or extending off the page.
- Add comprehensive Camera API documentation with examples - Expand System API with battery, device info, and network status methods - Add new API documentation for Audio, File, Network, and Share - Document QR code scanning functionality - Add Icons edge component documentation - Add packaging guide for distribution - Improve permission descriptions for camera, microphone, QR code, and network state - Update CI/CD documentation with deployment examples - Enhance assets documentation with usage examples - Refine native functions documentation - Update device dropdown to display correct platform names
|
I'll go through everything tonight 👍 |
gwleuverink
left a comment
gwleuverink
left a comment
There was a problem hiding this comment.
Wow you guys. I'm at a loss for words. V2 looks sick!
I've read everything through. So many great additions!
I have some observations. Please check out my comments.
Awesome work 🚀
|
|
||
| The `native:package` command creates signed, production-ready apps for distribution to the App Store and Play Store. This command handles all the complexity of code signing, building release artifacts, and preparing files for submission. | ||
|
|
||
| <aside class="relative z-0 mt-5 overflow-hidden rounded-2xl bg-pink-50 px-5 ring-1 ring-black/5 dark:bg-pink-600/10"> |
There was a problem hiding this comment.
We def need to highlight Bifrost here. The wall of text makes me want to skip reading.
Could we add a logo and a clear value proposition on top or something to that effect?
| {{-- Version switcher --}} | ||
| @if($platform === 'desktop') | ||
| <livewire:version-switcher :versions="[ | ||
| 1 => '1.x', |
There was a problem hiding this comment.
We need context aware filtering in the algolia results. Once this is merged results from 4 versions will show up (desktop & mobile v1 + v2)
| This single command takes care of everything and allows you to run new builds of your application without having to | ||
| learn any new editors or platform-specific tools. | ||
|
|
||
| <aside class="relative z-0 mt-5 overflow-hidden rounded-2xl bg-pink-50 px-5 ring-1 ring-black/5 dark:bg-pink-600/10"> |
There was a problem hiding this comment.
This goes for all the places where we use this aside. The dark:bg-pink-600/10 background doesn't blend well with the page bacground in dark mode.
Very subjective ofc. But to my eyes it creates dissonance
| <aside class="relative z-0 mt-5 overflow-hidden rounded-2xl bg-pink-50 px-5 ring-1 ring-black/5 dark:bg-pink-600/10"> | ||
|
|
||
| #### Note | ||
|
|
||
|
|
||
|
|
||
| ```php | ||
| 'hot_reload' => [ |
There was a problem hiding this comment.
Especially here the background of the aside doesn't match well with the higlighted code block. Doubling the color confusion mentioned before
|
|
||
| ## Releasing | ||
|
|
||
| To prepare your app for release, you should set the version number to a new version number that you have not used |
There was a problem hiding this comment.
Could we add a Bifrost banner here too?
| order: 150 | ||
| --- | ||
|
|
||
| ## What is EDGE? |
|
|
||
| ## Notes | ||
|
|
||
| - **Microphone Permission:** The first time your app requests microphone access, users will be prompted for permission. If denied, recording functions will fail silently. |
There was a problem hiding this comment.
I see the permissions/entitlements on the bottom of every page where a api needs it.
It makes sense to me to place any required entitlements way up top. So the user adds the entitlement before attempting to play with the feature. We should not bury critical steps to make the thing work
There was a problem hiding this comment.
perhaps a callout even makes sense here
| @@ -0,0 +1,256 @@ | |||
| --- | |||
| title: Icon System | |||
There was a problem hiding this comment.
Awesome yet compared to the other edge components not the most exciting. Would it make sense to put the Icon System on the bottom? The most exciting stuff up top
|
|
||
| This approach means you can use intuitive icon names and get consistent results across iOS and Android, even when the underlying platform icon names differ. | ||
|
|
||
| ## Platform Differences |
There was a problem hiding this comment.
This is a dynamic icon reference feature waiting to happen.
Would be really nice to have some sort of ui with icon preview for each platform based on icon string too
There was a problem hiding this comment.
Consider that a nice-to-have
| --- | ||
| title: EDGE Components | ||
| order: 5 | ||
| --- |
There was a problem hiding this comment.
Nice to have:
It would be very cool to have some sort of device switcher component that displays ios/android screenshots (or video) for these components.
If I'm just checking out the project it would be a huge selling point to actually see it renders true native components
Introduces comprehensive documentation for the mobile 2.x platform, including API references (biometrics, browser, camera, device, dialog, geolocation, haptics, push notifications, QR code, secure storage, system), concepts (CI/CD, databases, deep links, push notifications, security), and EDGE components (bottom nav, FAB, side nav, top bar). Also updates the docs index view to support a version switcher for the mobile platform.