Skip to content

Commit

Permalink
Updated reference links in the docs (#3458)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinmitrevski authored Oct 14, 2024
1 parent a70bb54 commit cb7cc07
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ Additionally, as with all StreamChat Controllers, `ChannelController` has `state
func controller(_ controller: DataController, didChangeState state: DataController.State)
```

You can use this delegate function to show any error states you might see. For more information, see [DataControllerStateDelegate Overview](../common-content/reference-docs/stream-chat/controllers/data-controller-state-delegate.md).
You can use this delegate function to show any error states you might see. For more information, see [DataControllerStateDelegate Overview](https://github.com/GetStream/stream-chat-swift/blob/a70bb5444abd3c8c109546a3637efe33576ab563/Sources/StreamChat/Controllers/DataController.swift#L68).
2 changes: 1 addition & 1 deletion docusaurus/docs/iOS/guides/attachments-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ let attachments: [AnyAttachmentPayload] = [
## Get Attachments

In both `v4.x` and `v3.2` the sequence of steps is the same:
- **[1]** get a `ChatMessage` model ([Working with messages](./working-with-messages.md))
- **[1]** get a `ChatMessage` model
- **[2]** get all attachments of the required type
- **[3]** access attachment fields

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/iOS/guides/migrating-from-1.x-and-2.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you're actively using one of these features, please hold off upgrading until

# StreamChat v1.x / v2.x -> StreamChatUI v4

None of the UI SDK components we had in v1.x / v2.x were carried over to StreamChatUI and it was written from the ground up. The new UI SDK is much more component-focused and each component can be used separately. Please check [UI Customization Guide](ui-customization.md) to get familiar on how to use it and convert your screens.
None of the UI SDK components we had in v1.x / v2.x were carried over to StreamChatUI and it was written from the ground up. The new UI SDK is much more component-focused and each component can be used separately. Please check [UI Customization Guide](../uikit/custom-components.md) to get familiar on how to use it and convert your screens.

# StreamChatCore v1.x / v2.x and StreamChatClient v2.x -> StreamChat v4

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/docs/iOS/guides/migrating-from-3-to-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ title: Migrating from 3.x to 4.x
The major version bump is due to the presence of several breaking changes. We believe they are easy to take care of in the upgrade process and improve the design of the library.

---
Please don't hesitate to contact us by sending an email to [email protected] or opening a ticket in our [GitHub repository](https://github.com/GetStream/stream-chat-swift). We'll help you during your migration process and any issues you might face.
Please don't hesitate to contact our Support team or open a ticket in our [GitHub repository](https://github.com/GetStream/stream-chat-swift). We'll help you during your migration process and any issues you might face.

---

## What's New in v4.x?

- UI components have an open API and are fully customizable. Review [UI Customization Guide](ui-customization.md) to learn more about how to customize UI components.
- UI components have an open API and are fully customizable. Review [UI Customization Guide](../uikit/custom-components.md) to learn more about how to customize UI components.
- Messages can have custom attachments. See [Attachments v4.x Migration](#attachments-v4x-migration) below.
- ExtraData is now stored in a Dictionary, instead of using generics. See [ExtraData Changes](#extradata-changes) below.
- `UIConfig` is split into `Appearance` and `Components` to improve clarity.
Expand Down Expand Up @@ -271,7 +271,7 @@ let attachments: [AnyAttachmentPayload] = [
### Get attachments

In both `v4.x` and `v3.2` the sequence of steps is the same:
- **[1]** get a `ChatMessage` model ([Working with messages](working-with-messages.md))
- **[1]** get a `ChatMessage` model
- **[2]** get all attachments of the required type
- **[3]** access attachment fields

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/docs/iOS/swiftui/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ let appearance = Appearance(colors: colors)
let streamChat = StreamChat(chatClient: chatClient, appearance: appearance)
```

In this way, you can change all the colors used in the SDK. For a complete reference, please visit this [page](../common-content/reference-docs/stream-chat-ui/appearance.color-palette.md).
In this way, you can change all the colors used in the SDK. For a complete reference, please check our source code [here](https://github.com/GetStream/stream-chat-swiftui/blob/develop/Sources/StreamChatSwiftUI/ColorPalette.swift).

### Changing Images

Expand All @@ -59,7 +59,7 @@ let appearance = Appearance(colors: colors, images: images)
let streamChat = StreamChat(chatClient: chatClient, appearance: appearance)
```

The full reference of images can be found [here](../common-content/reference-docs/stream-chat-ui/appearance.images.md).
The full reference of images can be found [here](https://github.com/GetStream/stream-chat-swiftui/blob/develop/Sources/StreamChatSwiftUI/Images.swift).

### Changing Fonts

Expand All @@ -76,7 +76,7 @@ let appearance = Appearance(colors: colors, fonts: fonts)
let streamChat = StreamChat(chatClient: chatClient, appearance: appearance)
```

Similarly, you can create your own font and replace the corresponding property. The full reference of fonts can be found [here](../common-content/reference-docs/stream-chat-ui/appearance.fonts.md).
Similarly, you can create your own font and replace the corresponding property. The full reference of fonts can be found [here](https://github.com/GetStream/stream-chat-swiftui/blob/develop/Sources/StreamChatSwiftUI/Fonts.swift).

### Changing Presentation Logic

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/iOS/uikit/components/channel-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ public var chatChannelListLoadingView: ChatChannelListLoadingView.Type = ChatCha

## Navigation

This component uses the [`ChannelListRouter`](../../common-content/reference-docs/stream-chat-ui/navigation/chat-channel-list-router.md) navigation component, you can customize this by providing your own.
This component uses the [`ChatChannelListRouter`](https://github.com/GetStream/stream-chat-swift/blob/develop/Sources/StreamChatUI/Navigation/ChatChannelListRouter.swift) navigation component, you can customize this by providing your own.

```swift
Components.default.channelListRouter = CustomChannelListRouter.self
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/iOS/uikit/custom-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
}
```

The full list of customizations exposed by `Components` is available [here](../common-content/reference-docs/stream-chat-ui/components.md#properties).
The full list of customizations exposed by `Components` is available [here](https://github.com/GetStream/stream-chat-swift/blob/develop/Sources/StreamChatUI/Components.swift).

## Components Lifecycle Methods

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/docs/iOS/uikit/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ Appearance style properties are organized in four groups:

### `colorPalette`

A color palette to provide basic set of colors for all UI components. The full reference can be found [here](../common-content/reference-docs/stream-chat-ui/appearance.color-palette.md).
A color palette to provide basic set of colors for all UI components. The full reference can be found [here](https://github.com/GetStream/stream-chat-swift/blob/develop/Sources/StreamChatUI/Appearance%2BColorPalette.swift).

### `fonts`

The set of fonts used by UI components. The full reference can be found [here](../common-content/reference-docs/stream-chat-ui/appearance.fonts.md).
The set of fonts used by UI components. The full reference can be found [here](https://github.com/GetStream/stream-chat-swift/blob/develop/Sources/StreamChatUI/Appearance%2BFonts.swift).

### `images`

The set of images used by UI components. The full reference can be found [here](../common-content/reference-docs/stream-chat-ui/appearance.images.md).
The set of images used by UI components. The full reference can be found [here](https://github.com/GetStream/stream-chat-swift/blob/develop/Sources/StreamChatUI/Appearance%2BImages.swift).

### `formatters`

Expand Down

0 comments on commit cb7cc07

Please sign in to comment.