Skip to content

Commit f7120d0

Browse files
authored
Minor fixes for storybook pages (#5746) (#5748)
1 parent 10a9987 commit f7120d0

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

packages/storybook8/stories/Composites/GettingStarted.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,15 @@ The following classes and interfaces handle some of the major features of the Az
105105
In our quickstart, we will be using the `CallAdapter` and `ChatAdapter` to power the `CallComposite` and `ChatComposite` respectively.
106106
Before we initialize the actual composite components, we need to set up the adapters that will power them first.
107107
These adapters take care of the entire state of the composites truly making them a turn-key solution.
108-
To setup the adapters, developers needs to pass information on the call or chat they want to join.
108+
To setup the adapters, developers need to pass information on the call or chat they want to join.
109109

110110
The adapters require access tokens, group IDs, or thread IDs to be setup.
111111
For this quickstart, the access tokens required need to have both `chat` and `VoIP` scopes.
112112
For more information on access tokens see: [Identity Model](https://docs.microsoft.com/azure/communication-services/concepts/identity-model#access-tokens)
113113
These elements come from services that go through the proper steps to generate these IDs and pass them to the client application.
114114
For more information, see: [Client Server Architecture](https://learn.microsoft.com/en-us/azure/communication-services/concepts/ui-library/ui-library-use-cases?pivots=platform-web#recommended-architecture).
115-
For Example: The Group Chat composite expects that the `userId` associated to the `token` being used to initialize it has already been joined to the `threadId` being provided.
116-
If the token hasn't been joined to the thread ID, then the Group Chat composite will fail.
115+
For example: The Group Chat composite expects that the `userId` associated to the `token` being used to initialize it has already been joined to the `threadId` being provided.
116+
If the token hasn't been joined to the `threadId`, then the Group Chat composite will fail.
117117
For more information on chat, see: [Getting Started with Chat](https://docs.microsoft.com/azure/communication-services/quickstarts/chat/get-started?pivots=programming-language-csharp)
118118

119119
Go to the `src` folder inside of [ui-library-quickstart-composites](https://github.com/Azure-Samples/communication-services-javascript-quickstarts/tree/main/ui-library-quickstart-composites) and look for the file `App.tsx`.

packages/storybook8/stories/StatefulClient/BestPractices.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ We are sharing some of our recommended best practices when handling state with A
88

99
## Use the Stateful Clients
1010

11-
Managing the complex state of a calling or chat sesion can be challenging. This was a complex problem we found we were in and we think many of our developer community
11+
Managing the complex state of a calling or chat session can be challenging. This was a complex problem we found we were in and we think many of our developer community
1212
will run into this challenge themselves. We wanted to find a convenient way to store this information on the client in a way that plays nicely with our components we are offering.
1313
By using the stateful client for calling or chat, you are on our recommended path for powering your own communications experience using Azure Communication Services.
1414

15-
## Use usePropsFor
15+
## Use `usePropsFor`
1616

1717
If you are using our provided UI Components, `usePropsFor` will help you get integrated with the underlying functionality quickly. This provides a series of properties our
1818
provided components are expecting from the stateful client to render an experience your users will be expecting. This is the fastest way to get your experience up and running with Azure Communication Services.

packages/storybook8/stories/StatefulClient/Chat/Docs.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ npm run start
8282

8383
The following classes and interfaces from the Azure Communication Services UI client library are referenced in this quickstart:
8484

85-
| Name | Description |
86-
| ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
87-
| [ChatClient](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-communication-chat/1.0.0/classes/chatclient.html) | Low-level chat library client. |
88-
| [createStatefulChatClient](.?path=/docs/stateful-client-overview--docs#chat-statefulclient) | Method to translate low-level library client into a stateful client for the UI Library |
89-
| [ChatClientProvider](./?path=/docs/stateful-client-react-hooks-setting-up--docs#chat) | Provider allows access to the Stateful Chat Client to the components inside of it |
90-
| [ChatThreadClientProvider](./?path=/docs/stateful-client-react-hooks-setting-up--docs#chat) | Provider allows access to the Stateful Chat Thread Client to the components inside of it |
91-
| [usePropsFor](.?path=/docs/stateful-client-react-hooks-usepropsfor--docs#usepropsfor-chat-app-example) | Hook to generate required props to enable UI Components |
85+
| Name | Description |
86+
| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
87+
| [ChatClient](https://learn.microsoft.com/en-us/javascript/api/@azure/communication-chat/chatclient?view=azure-node-latest) | Low-level chat library client. |
88+
| [createStatefulChatClient](.?path=/docs/stateful-client-overview--docs#chat-statefulclient) | Method to translate low-level library client into a stateful client for the UI Library |
89+
| [ChatClientProvider](./?path=/docs/stateful-client-react-hooks-setting-up--docs#chat) | Provider allows access to the Stateful Chat Client to the components inside of it |
90+
| [ChatThreadClientProvider](./?path=/docs/stateful-client-react-hooks-setting-up--docs#chat) | Provider allows access to the Stateful Chat Thread Client to the components inside of it |
91+
| [usePropsFor](.?path=/docs/stateful-client-react-hooks-usepropsfor--docs#usepropsfor-chat-app-example) | Hook to generate required props to enable UI Components |
9292

9393
## Instantiate Stateful Chat Client and Chat Thread Client
9494

0 commit comments

Comments
 (0)