Skip to content

Conversation

pinkeshmars
Copy link
Collaborator

Description

Add app launcher icon docs

Linear ticket and magic word Fixes DEVR-1124

Type of change

  • Typo fix
  • New feature
  • Enhancement to current docs
  • Removed outdated references
  • Update assets

:::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.
Copy link
Contributor

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)

Copy link
Collaborator Author

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
Copy link
Contributor

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

Copy link
Collaborator Author

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
Copy link
Contributor

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
Copy link
Contributor

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

Copy link
Collaborator Author

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
Copy link
Contributor

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)

@pinkeshmars
Copy link
Collaborator Author

@leighajarett you can take a look again.

@leighajarett leighajarett merged commit 6a7c8d4 into main Sep 29, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants