From 3204775ad8c6e9ae7b12bc4b885918c483c8b9ab Mon Sep 17 00:00:00 2001 From: Matthew Maxwell Date: Thu, 19 Oct 2023 10:35:32 -0500 Subject: [PATCH] Rebrand docs --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- deep-links/specification.md | 41 ++++++++++++-------------- retype.yml | 5 ++-- static/icon_bloom.png | Bin 0 -> 99606 bytes static/icon_firefly.png | Bin 10785 -> 0 bytes static/icon_firefly.svg | 6 ---- static/logo_bloom-dark.svg | 17 +++++++++++ static/logo_bloom-light.svg | 17 +++++++++++ 8 files changed, 57 insertions(+), 31 deletions(-) create mode 100644 static/icon_bloom.png delete mode 100644 static/icon_firefly.png delete mode 100644 static/icon_firefly.svg create mode 100644 static/logo_bloom-dark.svg create mode 100644 static/logo_bloom-light.svg diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index fba2a50..4be11d7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,7 +11,7 @@ body: - type: markdown attributes: value: | - Thank you for helping us make Bloom better, by reporting a bug you have found. This issue may already be reported! Please search on the [issue tracker](https://github.com/iotaledger/firefly/issues?q=is%3Aissue+is%3Aopen+label%3Atype%3Abug) before creating one. This form is for bugs only and not for help or support using this application. Please visit the [help and support discussions forum](https://github.com/iotaledger/firefly/discussions/categories/help-support) or join our [discord](https://discord.iota.org/) for help. + Thank you for helping us make Bloom better, by reporting a bug you have found. This issue may already be reported! Please search on the [issue tracker](https://github.com/bloomwalletio/bloom/issues?q=is%3Aopen+is%3Aissue+label%3Abug-report) before creating one. This form is for bugs only and not for help or support using this application. Please visit the [help and support discussions forum](https://github.com/bloomwalletio/bloom/issues/new?assignees=&labels=bug-report&projects=&template=bug_report.yml&title=%F0%9F%90%9E+-+) or join our [discord](https://discord.bloomwallet.io/) for help. - type: markdown attributes: diff --git a/deep-links/specification.md b/deep-links/specification.md index bd0f4b3..19bbca6 100644 --- a/deep-links/specification.md +++ b/deep-links/specification.md @@ -10,32 +10,32 @@ applications rather than a website. In our case we are interested in the user experiences that they enable between websites, applications, platforms, etc. by providing more interoperability. -Firefly has its own deep link scheme, exposing (limited) functionality that is required in +Bloom has its own deep link scheme, exposing (limited) functionality that is required in some type of user flow. A trivial example would be a user who buys native tokens on Soonaverse and must make a payment transaction to execute the buy order. Clicking on a deep link embedded inside the -Soonaverse platform triggers Firefly to open and auto-fill the transaction data as necessary, making it +Soonaverse platform triggers Bloom to open and auto-fill the transaction data as necessary, making it a simple confirm and click job for the user. :::caution -Firefly **will NEVER** automatically execute actions initiated by a deep link; they should **ALWAYS** require manual +Bloom **will NEVER** automatically execute actions initiated by a deep link; they should **ALWAYS** require manual confirmation on behalf of the user. ::: ## Scheme -The Firefly deep link scheme can be broken down to the following (simple) syntax: +The Bloom deep link scheme can be broken down to the following (simple) syntax: ``` -firefly[-]:///[?param=] +bloom[-]:///[?param=] ``` The parameters are as follows: - `stage` - indicates a specific stage of the app to target, options are: - - `alpha` - the first available version of Firefly containing brand new features - - `beta` - the next available version of Firefly containing new but slightly tested features - - `shimmer` - the Firefly Shimmer version, containing new and well-tested features -- `context` - the part of Firefly that contains the operation, options are: + - `alpha` - the first available version of Bloom containing brand new features + - `beta` - the next available version of Bloom containing new but slightly tested features + - `laters` - the Bloom Shimmer version, containing new and well-tested features +- `context` - the part of Bloom that contains the operation, options are: - `wallet` - managing coins and tokens - `collectibles` - managing NFTs - `governance` - managing voting events and proposals @@ -45,12 +45,9 @@ The parameters are as follows: If you wish to target the production version, simply omit this from the prefix: ``` -firefly:// +bloom:// ``` -:::caution -This deep link scheme is **NOT** compatible with Firefly V1, as that version of the application is in maintenance mode. -::: ## Contexts @@ -67,7 +64,7 @@ This operation brings the user to the send form popup: The deep link structure is as follows: ``` -firefly://wallet/sendForm?address=
&amount=[&unit=][&assetId=][&metadata=][&tag=] +bloom://wallet/sendForm?address=
&amount=[&unit=][&assetId=][&metadata=][&tag=] ``` The following parameters are **required**: @@ -86,12 +83,12 @@ The following parameters are **optional**: Example: -[!button Click me!](firefly://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi) +[!button Click me!](bloom://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi) Source: ``` -firefly://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi +bloom://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi ``` #### Send Confirmation @@ -105,7 +102,7 @@ This operation brings the user to the send confirmation popup: The deep link structure is as follows: ``` -firefly://wallet/sendConfirmation?address=
&amount=[&unit=][&assetId=][&metadata=][&tag=][&giftStorageDeposit=][&disableToggleGift=][&disableChangeExpiration=][&surplus=] +bloom://wallet/sendConfirmation?address=
&amount=[&unit=][&assetId=][&metadata=][&tag=][&giftStorageDeposit=][&disableToggleGift=][&disableChangeExpiration=][&surplus=] ``` The following parameters are **required**: @@ -128,12 +125,12 @@ The following parameters are **optional**: Example: -[!button Click me!](firefly://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&surplus=1&metadata=Take%20my%20money) +[!button Click me!](bloom://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&surplus=1&metadata=Take%20my%20money) Source: ``` -firefly://wallet/sendConfirmation?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&disableToggleGift=true&surplus=1&metadata=Take%20my%20money +bloom://wallet/sendConfirmation?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&disableToggleGift=true&surplus=1&metadata=Take%20my%20money ``` ### Collectibles @@ -153,7 +150,7 @@ This operation brings the user to the add proposal popup: The deep link structure is as follows: ``` -firefly://governance/addProposal?eventId=&nodeUrl= +bloom://governance/addProposal?eventId=&nodeUrl= ``` The following parameters are **required**: @@ -171,12 +168,12 @@ to manually enter the information. Example: -[!button Click me!](firefly://governance/addProposal?eventId=0x6d27606a773a3c87c151af09ad58ddc831864e2141ef598075dc24be5668ca7f7f&nodeUrl=https://api.testnet.shimmer.network) +[!button Click me!](bloom://governance/addProposal?eventId=0x6d27606a773a3c87c151af09ad58ddc831864e2141ef598075dc24be5668ca7f7f&nodeUrl=https://api.testnet.shimmer.network) Source: ``` -firefly://governance/addProposal?eventId=0x6d27606a773a3c87c151af09ad58ddc831864e2141ef598075dc24be5668ca7f7f&nodeUrl=https://api.testnet.shimmer.network +bloom://governance/addProposal?eventId=0x6d27606a773a3c87c151af09ad58ddc831864e2141ef598075dc24be5668ca7f7f&nodeUrl=https://api.testnet.shimmer.network ```