Skip to content

Commit

Permalink
Update broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolina Rymer committed Sep 27, 2023
1 parent 0c7129d commit 2002e20
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Explore these documentation sections for details:

- **Channels** - manage [channels](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/create), [join](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/join) or [leave](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/leave) them, [invite](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/invite) other chat members, or [reference channel names](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/references) in messages through hashtags.
- **Users** - manage [users](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/create), track user's [presence](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/presence), [mention](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/mentions) users, manage [permissions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/permissions) or [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/moderation) users for misbehaving.
- **Messages** - manage [messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/send-receive), add [reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions), [forward](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/forwards) messages to others, [pin](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/pinned) them to channels, add [quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quote) or [links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links), create [threads](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/threads) or send [files](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files), [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/moderation) offensive messages, or shows users how many messages they missed while they were offline through [unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread).
- **Messages** - manage [messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/send-receive), add [reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions), [forward](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/forward) messages to others, [pin](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/pinned) them to channels, add [quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quotes) or [links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links), create [threads](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/threads) or send [files](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files), [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/moderation) offensive messages, or shows users how many messages they missed while they were offline through [unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread).

Also, add [typing indicators](https://www.pubnub.com/docs/chat/chat-sdk/build/features/typing-indicator), [push notifications](/docs/chat/chat-sdk/build/features/push-notifications), and more.
Also, add [typing indicators](https://www.pubnub.com/docs/chat/chat-sdk/build/features/typing-indicator), [push notifications](https://www.pubnub.com/docs/chat/chat-sdk/build/features/push-notifications/docs/chat/chat-sdk/build/features/push-notifications), and more.

## Samples

Test our TypeScript sample chat apps created in various JavaScript frameworks:

| Source code | Framework | Description |
| :------------------------------------------------------------------------------------------ | :----------- | :--------------------------------------------------------------------------------------- |
| [Direct chat](https://github.com/pubnub/js-chat/tree/master/samples/getting-started) | React | Basic 1:1 support chat letting you exchange messages between a user and a support agent. |
| [Group chat](https://github.com/pubnub/js-chat/tree/master/samples/react-native-group-chat) | React Native | Feature-full group chat letting you test most of the features offered by the Chat SDK. |
| [Direct chat](https://github.com/pubnub/js-chat/blob/master/samples/getting-started/README.md) | React | Basic 1:1 support chat letting you exchange messages between a user and a support agent. |
| [Group chat](https://github.com/pubnub/js-chat/blob/master/samples/react-native-group-chat/README.md) | React Native | Feature-full group chat letting you test most of the features offered by the Chat SDK. |

## Chat SDK docs

You'll find all the information about working with Chat SDK in the official [PubNub Chat SDK documentation](pubnub.com/docs/chat/chat-sdk/overview).
You'll find all the information about working with Chat SDK in the official [PubNub Chat SDK documentation](https://www.pubnub.com/docs/chat/chat-sdk/overview).
4 changes: 2 additions & 2 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Explore these documentation sections for details:

- **Channels** - manage [channels](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/create), [join](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/join) or [leave](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/leave) them, [invite](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/invite) other chat members, or [reference channel names](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/references) in messages through hashtags.
- **Users** - manage [users](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/create), track user's [presence](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/presence), [mention](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/mentions) users, manage [permissions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/permissions) or [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/moderation) users for misbehaving.
- **Messages** - manage [messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/send-receive), add [reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions), [forward](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/forwards) messages to others, [pin](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/pinned) them to channels, add [quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quote) or [links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links), create [threads](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/threads) or send [files](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files), [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/moderation) offensive messages, or shows users how many messages they missed while they were offline through [unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread).
- **Messages** - manage [messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/send-receive), add [reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions), [forward](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/forward) messages to others, [pin](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/pinned) them to channels, add [quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quotes) or [links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links), create [threads](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/threads) or send [files](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files), [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/moderation) offensive messages, or shows users how many messages they missed while they were offline through [unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread).

Also, add [typing indicators](https://www.pubnub.com/docs/chat/chat-sdk/build/features/typing-indicator), [push notifications](/docs/chat/chat-sdk/build/features/push-notifications), and more.
Also, add [typing indicators](https://www.pubnub.com/docs/chat/chat-sdk/build/features/typing-indicator), [push notifications](https://www.pubnub.com/docs/chat/chat-sdk/build/features/push-notifications), and more.

## Samples

Expand Down
4 changes: 2 additions & 2 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This folder contains sample applications created with Chat SDK and various frame

Follow the instructions behind the links to run a chosen app.

* [getting-started](https://github.com/pubnub/js-chat/tree/master/samples/getting-started)
* [react-native-group-chat](https://github.com/pubnub/js-chat/tree/master/samples/react-native-group-chat)
* [getting-started](https://github.com/pubnub/js-chat/tree/master/samples/getting-started/README.md)
* [react-native-group-chat](https://github.com/pubnub/js-chat/tree/master/samples/react-native-group-chat/README.md)

This folder also contains [e2e automation tests](https://github.com/pubnub/js-chat/tree/master/samples/e2e-tests) covered with Playwright framework.
6 changes: 3 additions & 3 deletions samples/getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting started app

This Getting Started app shows how to set up a direct (1:1) chat using Chat SDK and React.
This Getting Started app shows how to set up a direct (1:1) chat using Chat SDK and React.

It comes with a pre-defined UI to showcase what the final product might look like.

Expand All @@ -15,8 +15,8 @@ This app is written using:

To run the Getting Started app, make sure to have the following:

* [yarn](https://classic.yarnpkg.com/en/docs/install)(>=1.22.19)
* [Node.js](https://nodejs.org/en/download/)(>=18.10.0)
* [yarn](https://classic.yarnpkg.com/en/docs/install) (>=1.22.19)
* [Node.js](https://nodejs.org/en/download/) (>=18.10.0)
* Code Editor (e.g. [Visual Studio Code](https://code.visualstudio.com/download))
* PubNub [Publish & Subscribe keys](https://www.pubnub.com/docs/basics/initialize-pubnub) that you can obtain from [Admin Portal](https://admin.pubnub.com/) after setting up an [account](https://www.pubnub.com/docs/setup/account-setup). The autogenerated **Demo Keyset** in **My First App** on the Admin Portal already contains the configuration required to complete this guide (enabled **App Context** and selected region).

Expand Down
4 changes: 2 additions & 2 deletions samples/react-native-group-chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To run the app on an iOS simulator, follow these steps:

1. Add your publish and subscribe keys.

Open the app in the code editor. Under the `samples/react-native-group-chat` folder, create a `.env` file and use it to specify values for [your publish and subscribe keys](/docs/chat/chat-sdk/build/sample-chat#get-pubsub-keys) from your app's keyset on the Admin Portal.
Open the app in the code editor. Under the `samples/react-native-group-chat` folder, create a `.env` file and use it to specify values for your publish and subscribe keys from your app's keyset on the Admin Portal.

```ts showLineNumbers
EXPO_PUBLIC_PUBNUB_PUB_KEY=
Expand Down Expand Up @@ -103,7 +103,7 @@ Messages:
* [Unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread)
* [Reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions)
* [Quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quotes)
* [Plain links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files)
* [Plain links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links)

Other:

Expand Down

0 comments on commit 2002e20

Please sign in to comment.