Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates contributor docs with more info about prerequisites #109

Merged
merged 2 commits into from
Apr 21, 2023
Merged

Updates contributor docs with more info about prerequisites #109

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b5602a
Updates contributor docs
JasonWeill Apr 21, 2023
23f6086
Removes mention of asdf
JasonWeill Apr 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/contributors/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.10, including recent Windows, macOS, and Linux versions. Python 3.11 is **not supported** due
to incompatibility with the [ray](https://pypi.org/project/ray/) library that we use.
If you are using an Apple Silicon-based Mac (M1, M1 Pro, M2, etc.), and you see an error when using
Python 3.10, try installing version 3.9 instead.

If you use `conda`, you can install Python 3.10 in your environment by running:

Expand All @@ -19,6 +21,13 @@ To use the `jupyter_ai` package in JupyterLab, as the development environment be
conda install jupyterlab
```

You will need Node.js 18 to use Jupyter AI. Node.js 18.16.0 is known to work.

:::{warning}
:name: node-18-15
Due to a compatibility issue with Webpack, Node.js 18.15.0 does not work with Jupyter AI.
:::

## Development install

First, install the Hatch CLI, which installs the Hatchling build backend automatically.
Expand Down