Skip to content

Commit d534de1

Browse files
committed
IBX-10163: Document integrated help
1 parent a055555 commit d534de1

File tree

5 files changed

+33
-6
lines changed

5 files changed

+33
-6
lines changed

docs/getting_started/discover_ui.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,29 @@ Focus mode is enabled by default when you first log into [[= product_name =]], b
144144
- in the drop-down menu on the right side of the top bar
145145

146146
![Focus mode switch](img/FM_switch.png "Focus mode switch")
147+
148+
## Help center [[% include 'snippets/lts-update_badge.md' %]]
149+
150+
If the Integrated help [LTS update]([[= developer_doc =]]/ibexa_products/editions/#lts-updates) has been installed in your application, you may notice that the ![Help center](about-info.png){.inline-image} icon appears at the bottom right of multiple screens.
151+
Click it to access documentation, trainings, and other relevant resources straight from the back office.
152+
153+
![Help center](img/help_center.png "Help center")
154+
155+
Contents of the help center are contextual:
156+
157+
- If you are an [editor](editor.md) or [store manager](shop_manager.md) working in a production environment, help center contains links to user documentation, release notes and product roadmap highlights.
158+
- If you are a developer whose task is to set up or extend the application, it links to developer documentation, API references and the GraphQL console.
159+
160+
Help center can be [customized]([[= developer_doc =]]/administration/back_office/customize_integrated_help/) to fit the needs of your organization, for example, to include links to your internal style guides.
161+
162+
### Dismiss help icon
163+
164+
It may happen that the help icon overlaps with other interface elements that you want to interact with.
165+
In such case, hover over the help icon and click the X icon to dismiss it.
166+
The help icon reappears when you reload the screen.
167+
168+
![Help obstructs UI](img/help_obstructs.png "Help obstructs UI")
169+
170+
### Disable help center
171+
172+
Help center is enabled by default, but you can toggle it in [user settings](get_started.md#browsing).

docs/getting_started/get_started.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ You can access your user settings on the right side of the top bar:
9090

9191
Here you can [change your user password](get_started.md#change-the-password) and define your user preferences, such as preferred timezone, short and full date, and time format, or back office language.
9292

93-
**Location**
93+
#### Location
9494

9595
|Setting|Description|
9696
--------|-----------|
@@ -102,7 +102,7 @@ Here you can [change your user password](get_started.md#change-the-password) and
102102
|Language|Sets the default language used in the back office.|
103103

104104

105-
**Content authoring**
105+
#### Content authoring
106106

107107
|Setting|Description|
108108
--------|-----------|
@@ -111,20 +111,21 @@ Here you can [change your user password](get_started.md#change-the-password) and
111111
|Enable character count in online editor|Enables or disables charactes count.|
112112
|Automatically open block settings in builders|Enables or disables the behavior of blocks used in builders.|
113113

114-
**Browsing**
114+
#### Browsing
115115

116116
|Setting|Description|
117117
--------|-----------|
118118
|Number of items displayed in the table|Sets the number of items displayed in sub-items.|
119-
|Location preview|Enables or disabled a thumbnail preview on the content tree.|
119+
|Location preview|Enables or disables a thumbnail preview on the content tree.|
120+
|Help center|Disables or enables the help center.|
120121

121-
**Mode**
122+
#### Mode
122123

123124
|Setting|Description|
124125
--------|-----------|
125126
|Focus mode|Enables or disables the [focus mode](discover_ui.md#focus-mode).|
126127

127-
**Dashboard**
128+
#### Dashboard
128129

129130
|Setting|Description|
130131
--------|-----------|
695 Bytes
Loading
238 KB
Loading
15.5 KB
Loading

0 commit comments

Comments
 (0)