Add PC Widget Docs #157
Add PC Widget Docs #157
Conversation
+ Add PC Widget - Unity in the sidebar, navbar, and home sections. + Add environment setup page for PC Widget Unity.
+ Add build project and configuration docs for PC Widget Unity
+ Add available apis and integration docs for PC Widget Unity
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
saga-hs
requested review from
rohan-helpshift,
chetanniradwarhs,
sumeet-helpshift and
hs-umang
and removed request for
chetanniradwarhs
| - This is typically invoked during the on-click action of a clickable element (e.g., a button). | ||
| - `Important:` Ensure that HelpShift.Initialize() has been called earlier in the game flow before invoking this method; otherwise, the widget will not function properly. | ||
|
|
||
| **Example Usage:** |
There was a problem hiding this comment.
specific language for snippet for formatting.
There was a problem hiding this comment.
It is not possible when we are using the <code> component
| ``` | ||
| Helpshift.Hide() | ||
| ``` | ||
| ### HelpShift.CleanUp |
There was a problem hiding this comment.
Make Helpshift consistent everywhere
There was a problem hiding this comment.
Do we want to start API names with capital letters? Or should it be Helpshift.show instead of `Helpshift.Show
There was a problem hiding this comment.
Helpshift made consistent
PC Widget C sharp API are like this Helpshift.Show
|
|
||
| **Description:** | ||
|
|
||
| Handles events sent from the HelpShift widget to Unity. This method is typically called inside Unity's Update() method. |
There was a problem hiding this comment.
Do we want to mention Helpshift Widget in the docs because it is internal to us and the customers/developers does need to know about it?
There was a problem hiding this comment.
Yes, as we are using Helpshift web widget in PC widget
| <Image src="/static/books/pc-widget-unity/publish-selection.png" width="half" /> | ||
|
|
||
|
|
||
| Configure the Publish option to produce the files in a local folder. |
There was a problem hiding this comment.
publish option & Use the below publish profile settings?
There was a problem hiding this comment.
Yes, but this is for internal use.
There was a problem hiding this comment.
I meant the lowercasing of the words 😅
| PlatformId = "mydomain_platform_123", | ||
| AppId = "3", | ||
| WidgetType = "helpcenter_and_webchat", | ||
| //////////////////////////////////// |
There was a problem hiding this comment.
Shouldn't the fields like Domain, PlatformId be in lowercase?
There was a problem hiding this comment.
It is because of the C sharp conventions
+ Change the layout of helpshift api docs to match other docs.
| <tr> | ||
| <td>Helpshift.Initialize</td> | ||
| <td> | ||
| Initializes the Helpshift widget and runs it in the background, enabling it to listen for notifications.<br/><br/> |
There was a problem hiding this comment.
Please change Helpshift widget -> Helpshift Widget everywhere
There was a problem hiding this comment.
Also check with product if we want to have PC widget as PC Widget?
There was a problem hiding this comment.
Going with Helpshift Pc Widget
| } from "@site/src/components/forDocs"; | ||
|
|
||
|
|
||
| A configuration object has to be created, which should be passed to the `initialize` API. |
There was a problem hiding this comment.
Rephrase this line. Ref to Web Widget page.
| A configuration object has to be created, which should be passed to the `initialize` API. | ||
| Below are the configuration options that we have**.** | ||
|
|
||
| # Mandatory Configuration |
There was a problem hiding this comment.
Remove this heading.
This could be labelled as base config. All configs should be at same level.
|
|
||
| ``` | ||
|
|
||
| 1. Replace `YOUR_DOMAIN` with your Helpshift domain. |
There was a problem hiding this comment.
Same description as point #2. Instead of giving text descriptions, use screenshot.
| For example, _happyapps_ if your dashboard sits at _happyapps.helpshift.com_. | ||
| 2. Replace `YOUR_PLATFORM_ID` with details found at `Settings` > `SDKs (for Developers)`. | ||
| <Image src="/static/books/web-chat/wc-embed-sdk.png" width="full" /> | ||
| 3. Replace `YOUR_APP_ID` with details found at `Settings` > `Your App (eg. Helpshift Demo App)` > `Publish ID`. |
There was a problem hiding this comment.
Settings > Your App (eg. Helpshift Demo App) > Publish ID
This part is not code snipped, avoid code formatting. Use em or bold if needed.
| 3. Replace `YOUR_APP_ID` with details found at `Settings` > `Your App (eg. Helpshift Demo App)` > `Publish ID`. | ||
| <Image src="/static/books/hs-widget/app-id.jpg" width="full" /> | ||
|
|
||
| Above mentioned configuration like `Domain`, `PlatformId`, `AppId` are mandatory for initializing the Helpshift PC Widget. For additional configurations refer below. |
There was a problem hiding this comment.
This should be part of top level descriptions.
|
|
||
| ## Helpshift.Initialize | ||
|
|
||
| **Description:** |
There was a problem hiding this comment.
Remove colon. Also use h4 or h5, better spacing as headers.
| | Parameter | Type | Description | | ||
| |-------------------|--------|------------------------------------------------------------------------------------------| | ||
| | `path` | string | The base path to the application's streaming assets, e.g., `Application.streamingAssetsPath`. | | ||
| | `helpshiftConfig` | object | A configuration object for the widget. | |
There was a problem hiding this comment.
Type here should be customer right?
There was a problem hiding this comment.
I added HelpshiftConfig as a type.
| This page provides a list of APIs available for the Helpshift PC widget along with their descriptions, parameters, and usage examples. | ||
| </Intro> | ||
|
|
||
| ## Helpshift.Initialize |
There was a problem hiding this comment.
Initialize Helpshift Widget
similar format at other places.
|
|
||
| <Admonition type="info" title="Note"> | ||
|
|
||
| In order to ensure a smooth migration for existing users, the default language is set to English (`en`) i.e. if you don't set the `Language` option in the `HelpshiftConfig` object, Helpshift PC Widget will use English as the language. You can set it to `browserDefault` in case you want your Helpshift PC Widget experience to be in the browser's language. |
There was a problem hiding this comment.
This not is confusing. In the context of a web widget browser makes sense, but in PC widget it does not. We need to discuss if we even need to support this.
| Step, | ||
| } from "@site/src/components/forDocs"; | ||
|
|
||
| # Users {#users} |
There was a problem hiding this comment.
userAuthToken part is missing.
No description provided.