Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
brichet committed Nov 14, 2024
1 parent 686eeb8 commit d439ebc
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 71 deletions.
1 change: 0 additions & 1 deletion docs/source/developers/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ maxdepth: 2
./jupyter-chat
./jupyterlab-collaborative-chat
./jupyterlab-ws-chat
```
39 changes: 0 additions & 39 deletions docs/source/developers/contributing/jupyterlab-ws-chat.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ required to build a chat. This package is designed to be used in an extension.
- `jupyterlab-collaborative-chat`, an extension built on top of `@jupyter/chat`, using
the collaborative edition as messaging system.

- `jupyterlab-ws-chat`, an other extension built on top of `@jupyter/chat`, using
websocket as messaging system.

```{toctree}
---
maxdepth: 3
Expand Down
28 changes: 0 additions & 28 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,34 +62,6 @@ area, like any other document.
Opening a chat from the left panel will open it in the left panel.
```

## Websocket chat

The `jupyterlab-ws-chat` extension adds a chat panel using websocket for messages
exchange.

```{warning}
This extension is currently under development, and users may encounter issues with it.
```

### Install websocket chat

The websocket chat is available on [PyPI](https://pypi.org/project/jupyterlab-ws-chat/).

```bash
pip install jupyterlab-ws-chat
```

To uninstall the package:

```bash
pip uninstall jupyterlab-ws-chat
```

### Open the chat

The chat can be opened from the left panel
![chat icon](../../../packages/jupyter-chat/style/icons/chat.svg){w=24px}.

## Chat usage

The chat UI is composed of a list of messages and an input to send new messages.
Expand Down

0 comments on commit d439ebc

Please sign in to comment.