From d439ebc218524268c8615e59989f4ad5a763a626 Mon Sep 17 00:00:00 2001 From: Nicolas Brichet Date: Thu, 14 Nov 2024 15:12:17 +0100 Subject: [PATCH] Update documentation --- docs/source/developers/contributing/index.md | 1 - .../contributing/jupyterlab-ws-chat.md | 39 ------------------- docs/source/index.md | 3 -- docs/source/users/index.md | 28 ------------- 4 files changed, 71 deletions(-) delete mode 100644 docs/source/developers/contributing/jupyterlab-ws-chat.md diff --git a/docs/source/developers/contributing/index.md b/docs/source/developers/contributing/index.md index 52c13282..e0303687 100644 --- a/docs/source/developers/contributing/index.md +++ b/docs/source/developers/contributing/index.md @@ -12,5 +12,4 @@ maxdepth: 2 ./jupyter-chat ./jupyterlab-collaborative-chat -./jupyterlab-ws-chat ``` diff --git a/docs/source/developers/contributing/jupyterlab-ws-chat.md b/docs/source/developers/contributing/jupyterlab-ws-chat.md deleted file mode 100644 index 02a82e60..00000000 --- a/docs/source/developers/contributing/jupyterlab-ws-chat.md +++ /dev/null @@ -1,39 +0,0 @@ -# Websocket chat - -The `jupyterlab-ws-chat` extension adds a chat panel relying on websocket for messaging. - -## Development installation - -Installing this extension in development mode requires an environment with *python* and -*nodejs*. - -```bash -# In the following commands, 'mamba' can be replaced with 'conda' -mamba create -n jupyter-chat python nodejs -mamba activate jupyter-chat -``` - -The following commands install the extension in development mode: - -```bash -# Install the extension -./scripts/dev_install.sh ws - -# Symlink the assets -jupyter labextension develop --overwrite python/jupyterlab-ws-chat -``` - -To uninstall it, run: - -```bash -pip uninstall jupyterlab-ws-chat -``` - -## Building the assets - -Changes in typescript sources of `@jupyter/chat` or `jupyterlab-ws-chat` must -be build again to be available in the jupyterlab. - -```bash -jlpm build:ws -``` diff --git a/docs/source/index.md b/docs/source/index.md index ad3781e8..ca615bd1 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -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 diff --git a/docs/source/users/index.md b/docs/source/users/index.md index 8e8c4b28..c9512bad 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -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.