Documents server 2 as a requirement (jupyterlab#158)

dbelgrod · May 11, 2023 · 7290c44 · 7290c44
1 parent c9bc406
commit 7290c44
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/source/users/index.md b/docs/source/users/index.md
@@ -26,6 +26,12 @@ To use the `jupyter_ai` package, you will also need to have a currently-maintain
 conda install jupyterlab
 ```
 
+You should have Jupyter Server 2.x (not 1.x) installed. A fresh install of JupyterLab 3.6.x should come with Server 2.x. You can find your current Server version by running `jupyter --version` and checking for a line beginning with `jupyter_server`. To upgrade your version of Jupyter Server, run:
+
+```
+pip install jupyter_server --upgrade
+```
+
 You can use the `jupyter_ai_magics` package without JupyterLab, but you will need a compatible interface, such as [IPython](https://ipython.org/).
 
 ## Model providers

diff --git a/packages/jupyter-ai/README.md b/packages/jupyter-ai/README.md
@@ -10,6 +10,7 @@ for the frontend extension.
 ## Requirements
 
 - JupyterLab >= 3.5 (not JupyterLab 4)
+- Jupyter Server >= 2.0.0
 
 ## Installation