diff --git a/docs/source/contributors/index.md b/docs/source/contributors/index.md index c081ebc2e..952adafbc 100644 --- a/docs/source/contributors/index.md +++ b/docs/source/contributors/index.md @@ -6,6 +6,8 @@ This page is intended for people interested in building new or modified function You can develop Jupyter AI on any system that can run a supported Python version up to and including 3.11, including recent Windows, macOS, and Linux versions. +Each Jupyter AI major version works with only one major version of JupyterLab. Jupyter AI 1.x supports JupyterLab 3.x, and Jupyter AI 2.x supports JupyterLab 4.x. + We highly recommend that you install [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) to start developing on Jupyter AI, especially if you are developing on macOS on an Apple Silicon-based Mac (M1, M1 Pro, M2, etc.). You will need Node.js 18 to use Jupyter AI. Node.js 18.16.0 is known to work. diff --git a/docs/source/index.md b/docs/source/index.md index b93973a96..045c92d8f 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -10,6 +10,17 @@ in JupyterLab and the Jupyter Notebook. More specifically, Jupyter AI offers: * Support for a wide range of generative model providers and models (AI21, Anthropic, Cohere, Hugging Face, OpenAI, SageMaker, etc.). +## JupyterLab support + +**Each major version of Jupyter AI supports *only one* major version of JupyterLab.** Jupyter AI 1.x supports +JupyterLab 3.x, and Jupyter AI 2.x supports JupyterLab 4.x. The feature sets of versions 1.0.0 and 2.0.0 +are the same. We will maintain support for JupyterLab 3 for as long as it remains maintained. + +The `main` branch of Jupyter AI targets the newest supported major version of JupyterLab. All new features and most bug fixes will be +committed to this branch. Features and bug fixes will be backported +to work on JupyterLab 3 only if developers determine that they will add sufficient value. +**We recommend that JupyterLab users who want the most advanced Jupyter AI functionality upgrade to JupyterLab 4.** + ## Contents ```{toctree}