From afb4ad54974ad5fbe800277ffee7a1aa11d3f18b Mon Sep 17 00:00:00 2001 From: Murat Ursavas Date: Fri, 2 Aug 2024 11:28:08 +0300 Subject: [PATCH 1/2] Added Global Branding information --- docs/EdgeApps.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/EdgeApps.md b/docs/EdgeApps.md index a2052ae..5842d26 100644 --- a/docs/EdgeApps.md +++ b/docs/EdgeApps.md @@ -292,7 +292,43 @@ To use the settings in your Edge App, include them in your HTML or JavaScript fi Settings are key-value pairs that users installing the app must provide at install time and can later edit. --- +## Global Branding Settings +Global Branding Settings is a feature, developed to provide related visual identity information, via fetching the information from the public customer web site automatically, based on their email domain. This feature is available automatically for every Edge App. Nothing special has to be done by the developer to get following settings. +### Branding Settings List +* screenly_color_accent +* screenly_color_light +* screenly_logo_light + +#### screenly_color_accent + +This is the accent color of the customers brand. + +| Setting | Example Value +| --------| ------------- +| screenly_color_accent | #972eff | + +#### screenly_color_light + +This is the base color based on light theme. + +| Setting | Example Value +| --------| ------------- +| screenly_color_light | #adafbe + +#### screenly_logo_light + +This is the company logo based on light theme. + +| Setting | Example Value +| --------| ------------- +| screenly_logo_light | https://us-assets.screenlyapp.com/1dp2TKWzR0BCB38bI170Xf + +### Notes on Branding Settings + +These settings are available to the Edge App like the usual settings. But they cannot be listed, fetched, changed with CLI. + +--- ## Secrets ### Defining a Secret From b60e695c59c8278a48aef1c60fcd13f0b0c28719 Mon Sep 17 00:00:00 2001 From: Murat Ursavas Date: Fri, 2 Aug 2024 11:49:08 +0300 Subject: [PATCH 2/2] Rephrased by ChatGPT --- docs/EdgeApps.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/EdgeApps.md b/docs/EdgeApps.md index 5842d26..af90b6c 100644 --- a/docs/EdgeApps.md +++ b/docs/EdgeApps.md @@ -293,7 +293,8 @@ Settings are key-value pairs that users installing the app must provide at insta --- ## Global Branding Settings -Global Branding Settings is a feature, developed to provide related visual identity information, via fetching the information from the public customer web site automatically, based on their email domain. This feature is available automatically for every Edge App. Nothing special has to be done by the developer to get following settings. + +The Global Branding Settings feature automatically provides relevant visual identity information by fetching it from the public sources based on their email domain. This functionality is available by default for every Edge App, requiring no special actions from the developer to access the following settings: ### Branding Settings List * screenly_color_accent @@ -302,31 +303,31 @@ Global Branding Settings is a feature, developed to provide related visual ident #### screenly_color_accent -This is the accent color of the customers brand. +This is the accent color of the customer's brand. -| Setting | Example Value -| --------| ------------- -| screenly_color_accent | #972eff | +| Setting | Example Value | +|-----------------------|----------------| +| screenly_color_accent | #972eff | #### screenly_color_light -This is the base color based on light theme. +This is the base color for the light theme. -| Setting | Example Value -| --------| ------------- -| screenly_color_light | #adafbe +| Setting | Example Value | +|----------------------|----------------| +| screenly_color_light | #adafbe | #### screenly_logo_light -This is the company logo based on light theme. +This is the company logo for the light theme. -| Setting | Example Value -| --------| ------------- -| screenly_logo_light | https://us-assets.screenlyapp.com/1dp2TKWzR0BCB38bI170Xf +| Setting | Example Value | +|---------------------|----------------------------------------------------------------------| +| screenly_logo_light | [screenly_logo_light](https://us-assets.screenlyapp.com/1dp2TKWzR0BCB38bI170Xf) | ### Notes on Branding Settings -These settings are available to the Edge App like the usual settings. But they cannot be listed, fetched, changed with CLI. +These settings are available to the Edge App like the usual settings but cannot be listed, fetched, or changed with CLI. --- ## Secrets