Skip to content

Commit d947fa1

Browse files
oliwiapolecoliwiapolec
authored
feat(docs): fixes in docs 11/25
1 parent cc598ae commit d947fa1

File tree

97 files changed

+2198
-2151
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+2198
-2151
lines changed

‎_redirects‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
/extending-chat-widget/javascript-api/v3.0/* /docs/extending-chat-widget/javascript-api/:splat 301
1313
/platform-overview/* /docs/getting-started/:splat 301
1414
/building-apps-for-livechat/* /docs/getting-started/guides/:splat 301
15-
/build-integration/* /docs/getting-started/guides/webhook-apps/:splat 301
15+
/build-integration/* /docs/guides/livechat-apps/#building-a-webhook-app/:splat 301
1616
/how-to-monetize-apps/* /docs/monetization/how-to-monetize-apps/:splat 301
1717
/sign-in-with-livechat/* /docs/getting-started/authorization/sign-in-with-livechat/:splat 301
1818
/agent-chat-api/* /docs/messaging/agent-chat-api/:splat 301
@@ -42,7 +42,6 @@
4242
/changelog/ /docs/messaging/ 301
4343
/chat-widget-moments/ /docs/extending-chat-widget/chat-widget-moments/ 301
4444
/chat-widget-themes/ /docs/extending-chat-widget-customer-sdk 301
45-
/management/getting-started/guides/webhook-apps/* /docs/getting-started/livechat-apps/webhook-apps/:splat 301
4645
/management/webhooks/changelog/* /docs/management/changelog/:splat 301
4746
/management/webhooks/v3.3/changelog/* /docs/management/changelog/:splat 301
4847
/messaging/rtm-reference/ /docs/messaging/ 301
@@ -70,6 +69,8 @@
7069
/getting-started/installing-livechat/* /docs/guides/installing-livechat/:splat 301
7170
/getting-started/livechat-apps/* /docs/guides/livechat-apps/:splat 301
7271
/getting-started/helpdesk-apps/* /docs/guides/helpdesk-apps/:splat 301
72+
/guides/livechat-apps/webhook-apps/* /docs/guides/livechat-apps/#building-a-webhook-app/:splat 301
73+
7374

7475
# Redirect images so can work on netlify and /docs domain
7576
/docs/images/* /images/:splat 200

‎src/pages/guides/livechat-apps/webhook-apps/images/livechat-developers-console-create-auth.png‎ renamed to ‎public/images/guides/livechat-developers-console-create-auth.png‎

File renamed without changes.

‎src/assets/icons/cards/Changelog.js‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
export const ChangelogIcon = ({ fill, background, ...rest }) => (
2+
<svg
3+
width="30"
4+
height="30"
5+
viewBox="0 0 30 30"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
{...rest}
9+
>
10+
<rect width="30" height="30" rx="4" fill={background || "#003288"} />
11+
<g clipPath="url(#clip0_2989_1156)">
12+
<path
13+
d="M12 7V25M9 7H20C20.5304 7 21.0391 7.21071 21.4142 7.58579C21.7893 7.96086 22 8.46957 22 9V21C22 21.5304 21.7893 22.0391 21.4142 22.4142C21.0391 22.7893 20.5304 23 20 23H9C8.73478 23 8.48043 22.8946 8.29289 22.7071C8.10536 22.5196 8 22.2652 8 22V8C8 7.73478 8.10536 7.48043 8.29289 7.29289C8.48043 7.10536 8.73478 7 9 7V7Z"
14+
stroke={fill || "white"}
15+
strokeWidth="2"
16+
strokeLinecap="round"
17+
strokeLinejoin="round"
18+
/>
19+
<path
20+
d="M16 11H18"
21+
stroke={fill || "white"}
22+
strokeWidth="2"
23+
strokeLinecap="round"
24+
strokeLinejoin="round"
25+
/>
26+
<path
27+
d="M16 15H18"
28+
stroke={fill || "white"}
29+
strokeWidth="2"
30+
strokeLinecap="round"
31+
strokeLinejoin="round"
32+
/>
33+
</g>
34+
<defs>
35+
<clipPath id="clip0_2989_1156">
36+
<rect width="24" height="24" fill="white" transform="translate(3 3)" />
37+
</clipPath>
38+
</defs>
39+
</svg>
40+
);

‎src/assets/icons/cards/DevConsoleTools.js‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎src/assets/icons/cards/GettingStartedCard.js‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
export const GettingStartedCardIcon = ({ fill, background, ...rest }) => (
2+
<svg
3+
width="30"
4+
height="30"
5+
viewBox="0 0 30 30"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
{...rest}
9+
>
10+
<rect width="30" height="30" rx="4" fill={background || "#FFD000"} />
11+
<g clipPath="url(#clip0_2989_1125)">
12+
<path
13+
d="M15 24C17.3869 24 19.6761 23.0518 21.364 21.364C23.0518 19.6761 24 17.3869 24 15C24 12.6131 23.0518 10.3239 21.364 8.63604C19.6761 6.94821 17.3869 6 15 6C12.6131 6 10.3239 6.94821 8.63604 8.63604C6.94821 10.3239 6 12.6131 6 15C6 17.3869 6.94821 19.6761 8.63604 21.364C10.3239 23.0518 12.6131 24 15 24Z"
14+
stroke={fill || "white"}
15+
strokeWidth="2"
16+
strokeLinecap="round"
17+
strokeLinejoin="round"
18+
/>
19+
<path
20+
d="M13.7773 11.5182C13.4451 11.2967 13 11.5349 13 11.9343L13 18.0657C13 18.4651 13.4451 18.7033 13.7774 18.4818L18.376 15.416C18.6728 15.2181 18.6728 14.7819 18.376 14.584L13.7773 11.5182Z"
21+
fill={fill || "white"}
22+
stroke={fill || "white"}
23+
strokeWidth="2"
24+
strokeLinecap="round"
25+
strokeLinejoin="round"
26+
/>
27+
</g>
28+
<defs>
29+
<clipPath id="clip0_2989_1125">
30+
<rect width="24" height="24" fill="white" transform="translate(3 3)" />
31+
</clipPath>
32+
</defs>
33+
</svg>
34+
);

‎src/configs/containers.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,6 @@
3939
"slug": "/messaging/customer-chat-api",
4040
"title": "Customer Chat API"
4141
},
42-
{
43-
"slug": "/messaging/node-sdk/",
44-
"title": "LiveChat Node.js SDK"
45-
},
4642
{
4743
"slug": "/messaging/go-sdk/",
4844
"title": "LiveChat Go SDK"

‎src/constants/cards.js‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,32 @@ import { ChatWidgetIcon } from "assets/icons/cards/ChatWidget";
66
import { HelpDeskApiIcon } from "assets/icons/cards/HelpDeskAPI";
77
import { AuthorizationIcon } from "assets/icons/cards/Authorization";
88
import { MonetizationIcon } from "assets/icons/cards/Monetization";
9-
import { DevConsoleToolsIcon } from "assets/icons/cards/DevConsoleTools";
10-
import { TextApiIcon } from "assets/icons/cards/TextAPI";
119
import { BeginnerPathIcon } from "assets/icons/cards/BeginnerPath";
1210
import { AdvancedPathIcon } from "assets/icons/cards/AdvancedPath";
1311
import { PartnerApiIcon } from "assets/icons/cards/PartnerAPI";
1412
import { GuidesIcon } from "assets/icons/cards/Guides";
13+
import { GettingStartedCardIcon } from "assets/icons/cards/GettingStartedCard";
14+
import { ChangelogIcon } from "assets/icons/cards/Changelog";
1515

1616
export const cards = [
17+
{
18+
title: "Getting started",
19+
link: "/getting-started",
20+
copy: "Learn the fundamentals needed to work with Text APIs.",
21+
image: <GettingStartedCardIcon />,
22+
},
1723
{
1824
title: "Guides and tutorials",
1925
link: "/guides",
2026
copy: "Step-by-step explainers for using APIs and the Text Platform.",
2127
image: <GuidesIcon />,
2228
},
29+
{
30+
title: "Authorization",
31+
link: "/authorization",
32+
copy: "Authenticate and authorize users with OAuth flows. Manage scopes.",
33+
image: <AuthorizationIcon />,
34+
},
2335
{
2436
title: "Messaging",
2537
link: "/messaging",
@@ -33,7 +45,7 @@ export const cards = [
3345
image: <ManagementIcon />,
3446
},
3547
{
36-
title: "Data and Reporting",
48+
title: "Data and reporting",
3749
link: "/data-reporting",
3850
copy: "Extract data to build custom reports and dashboards.",
3951
image: <DataReportingIcon />,
@@ -50,42 +62,30 @@ export const cards = [
5062
copy: "Monitor and interact with visitors via rich messages and apps.",
5163
image: <ChatWidgetIcon />,
5264
},
53-
{
54-
title: "HelpDesk API",
55-
link: "/helpdesk",
56-
copy: "Build integration for our ticketing system, HelpDesk.",
57-
image: <HelpDeskApiIcon />,
58-
},
59-
{
60-
title: "Authorization",
61-
link: "/authorization",
62-
copy: "Authenticate and authorize users with OAuth flows. Manage scopes.",
63-
image: <AuthorizationIcon />,
64-
},
6565
{
6666
title: "Monetization",
6767
link: "/monetization",
6868
copy: "Seamless payment configuration right within the Platform.",
6969
image: <MonetizationIcon />,
7070
},
7171
{
72-
title: "Developer Console Guides",
73-
link: "/guides/console-guides",
74-
copy: "Learn how to configure your app with Developer Console tools.",
75-
image: <DevConsoleToolsIcon />,
76-
},
77-
{
78-
title: "Text APIs",
79-
link: "/text",
80-
copy: "Build products powered by advanced text operations.",
81-
image: <TextApiIcon />,
72+
title: "HelpDesk API",
73+
link: "/helpdesk",
74+
copy: "Build integration for our ticketing system, HelpDesk.",
75+
image: <HelpDeskApiIcon />,
8276
},
8377
{
8478
title: "Partner API",
8579
link: "/partner-program",
8680
copy: "Manage Partner Program data and integrate it into your systems.",
8781
image: <PartnerApiIcon />,
8882
},
83+
{
84+
title: "Changelog",
85+
link: "/changelog",
86+
copy: "Keep track of changes and updates to the available APIs.",
87+
image: <ChangelogIcon />,
88+
},
8989
];
9090

9191
export const devPaths = [

‎src/pages/authorization/agent-authorization/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ To make calls to Customer Chat API, you need a different `access_token`. For tha
2828

2929
## Postman collection
3030

31-
You can find all the requests from the Agent and Customer authorization flows in Postman. Remember to replace sample parameters with your own.
31+
You can find all the requests from the agent and customer authorization flows in Postman. Remember to replace sample parameters with your own.
3232

3333
[<div style={{maxWidth: '123px'}}><img alt="Run in Postman" src="https://run.pstmn.io/button.svg" width="123px" height="30px"/></div>](https://god.gw.postman.com/run-collection/20754404-ab4b398a-f906-4431-a17c-2f6673f0b8e8?action=collection%2Ffork&collection-url=entityId%3D20754404-ab4b398a-f906-4431-a17c-2f6673f0b8e8%26entityType%3Dcollection%26workspaceId%3D5e6fb31b-587b-4258-b215-4dccaae38a38)
3434

3535
# Personal Access Tokens
3636

37-
Unlike other authorization flows that let you acquire a token for your app, **Personal Access Tokens (PATs)** are generated per Agent. PATs are great when you want to make a quick call to the LiveChat API or test out the app you're working on.
37+
Unlike other authorization flows that let you acquire a token for your app, **Personal Access Tokens (PATs)** are generated per agent. PATs are great when you want to make a quick call to the LiveChat API or test out the app you're working on.
3838

3939
To sign a request with a Personal Access Token, you need to:
4040

@@ -416,7 +416,7 @@ The response is a JSON with the following parameters:
416416
| Parameter | Description |
417417
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
418418
| `access_token` | A token you can use to call LiveChat APIs on behalf of the user. |
419-
| `account_id` | The ID of the Agent's account |
419+
| `account_id` | The ID of the agent's account |
420420
| `expires_in` | A number in seconds specifying how long the `access_token` will be valid; 28800 sec by default. When it expires, you will need to generate a new `access_token` using `refresh_token` (read [Using the refresh token](#using-the-refresh-token) for more details). |
421421
| `organization_id` | The ID of the organization's account. |
422422
| `refresh_token` | A token that can be used to generate new access tokens. |
@@ -522,7 +522,7 @@ The response is a JSON with the following parameters:
522522
| Parameter | Description |
523523
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
524524
| `access_token` | A token you can use to call LiveChat APIs on behalf of the user. |
525-
| `account_id` | The ID of the Agent's account |
525+
| `account_id` | The ID of the agent's account |
526526
| `expires_in` | A number in seconds specifying how long the `access_token` will be valid. When it expires, you will need to generate a new `access_token` using `refresh_token` (read [Using the refresh token](#using-the-refresh-token) for more details). |
527527
| `organization_id` | the ID of the organization's account. |
528528
| `scope` | A comma-separated list of permissions an `access_token` has. |
@@ -656,7 +656,7 @@ The response is a JSON with the following parameters:
656656
| Parameter | Description |
657657
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
658658
| `access_token` | A token you can use to call LiveChat APIs on behalf of the user. |
659-
| `account_id` | The ID of the Agent's account |
659+
| `account_id` | The ID of the agent's account |
660660
| `client_id` | **Client Id** of your app |
661661
| `expires_in` | A number in seconds specifying how long the `access_token` will be valid. When it expires, you will need to generate a new `access_token` using `refresh_token` (read [Using the refresh token](#using-the-refresh-token) for more details). |
662662
| `organization_id` | The ID of the organization's account. |

0 commit comments

Comments
 (0)