Skip to content

Commit

Permalink
tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amcdnl committed Jul 29, 2024
1 parent 30759ef commit 7f97b2a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions stories/Api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Meta } from '@storybook/addon-docs';
<Meta title="Docs/API" />

# API
Below is the API for the `sessions` and `conversations` data.

```ts
export interface ConversationSource {
Expand All @@ -21,7 +22,9 @@ export interface ConversationSource {
*/
image?: string;
}
```

```ts
export interface ConversationFile {
/**
* Name of the file
Expand All @@ -43,7 +46,9 @@ export interface ConversationFile {
*/
url?: string;
}
```

```ts
export interface Conversation {
/**
* Unique identifier for the conversation
Expand Down Expand Up @@ -80,7 +85,9 @@ export interface Conversation {
*/
files?: ConversationFile[];
}
```

```ts
export interface Session {
/**
* Unique identifier for the session
Expand Down
2 changes: 1 addition & 1 deletion stories/Customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Below is a diagram of the components that make up the package.

<img src={diagram} alt="Architecture" width="50%" style={{ margin: '0 auto' }} />

### Example
### Custom Components Example
Below is example markup that creates a custom session empty message and also
provides a custom session list item.

Expand Down

0 comments on commit 7f97b2a

Please sign in to comment.