-
Notifications
You must be signed in to change notification settings - Fork 1
Add app launcher icon docs #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
:::info | ||
|
||
- The Agent can’t generate a launcher icon image for you; you need to upload your own image file in the **Assets** module. | ||
- The app icon is generated during native builds (Android/iOS) before deployment. However, if you want to verify that it’s configured correctly, [**download**](../test/test-on-mobile-device.md#download-code-and-run) the project, run the following command in the terminal, then run the app on a device and check device’s home screen to confirm the new icon appears. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"run the following command in the terminal" can be confusing - make sure to point users to documentation on how to download the code, set up local flutter environment, and then run the proper command (since we dont expose terminal in dreamflow)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
|
||
1. Go to the [**Assets**](../../workspace/modules-panel/assets.md) module in Dreamflow and upload your icon image. For best results, use a square, high-resolution source image (i.e., **1024×1024 px**) to ensure your app icon looks sharp across all devices and sizes. | ||
2. Update the code to use the new app icon. Dreamflow uses the [`flutter_launcher_icons`](https://pub.dev/packages/flutter_launcher_icons) package to set launcher icons for both platforms. You can either: | ||
- Ask the Agent to do it automatically, or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a sample prompt for asking the agent? It would be helpful to see how we can make it clear to the agent which image file to use
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added!
``` | ||
::: | ||
|
||
### Platform-Specific Icon Configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a sample prompt for how to prompt the agent to do this after you've uploaded different image files
- **`image_path_android`**: Path to the Android app icon. | ||
- **`image_path_ios`**: Path to the iOS app icon. | ||
|
||
### Adaptive Icons for Android |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above with sample prompt... make sure to test the sample prompts so they work well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added! Yes, I tested all three and then included them here.
12. **Offline & Poor Network Support**: Validate app behavior with no connectivity and high-latency/packet-loss scenarios. Provide cached content, retry/backoff for API calls, and clear offline states. | ||
|
||
|
||
## Add App Launcher Icon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Older dreamflow projects didnt have the launch icon added and also didnt have the package added. Can we add a faq at the bottom of this page that says something like:
-
If you see xxx error it means that the flutter_launcher package wasn't properly added to your project, to add it you can .... (either add to pubspec and manually refresh dependencies by clicking the button or ask the agent... by clicking "fix with AI" when you see the error) - to get a feel for what users would actually see here, please test removing the package and trying to deploy
-
If you see xxx error it means now launch icon is specified ... the redirect them to section on adding a launch icon (you can test this out by removing the dreamflow launch icon from project + removing the part of the pubspec that adds it)
@leighajarett you can take a look again. |
Description
Add app launcher icon docs
Linear ticket and magic word Fixes DEVR-1124
Type of change