-
-
Notifications
You must be signed in to change notification settings - Fork 325
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.
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
Upgrade to JupyterLab 4 #296
Conversation
Had a discussion with the team. We have settled on the following versioning strategy:
I will update the documentation in this PR accordingly. |
I noticed an error in our user documentation:
This is not true. We previously had users install certain dependencies via Conda due to upstream issues with Ray, but Jupyter AI does not have a Conda Forge distribution. You cannot install Jupyter AI with Conda, though you can install it within Conda. This issue is tracked here: #181 I'll update the documentation as I see fit here. @JasonWeill This should require your review. |
I also took the liberty of rearranging the sections in the user documentation. For some reason, the "Requirements" and "Installation" section were interrupted by the "Model providers" section in between. I found this to be really confusing. I've moved "Model providers" after "Installation" to remedy this. |
packages/jupyter-ai-module-cookiecutter/{{cookiecutter.labextension_name}}/README.md
Outdated
Show resolved
Hide resolved
packages/jupyter-ai-module-cookiecutter/{{cookiecutter.labextension_name}}/pyproject.toml
Outdated
Show resolved
Hide resolved
Yes, but you did those prerequisites in a separate Conda environment. If you create and activate a new Conda environment, you need to reinstall JupyterLab.
I disagree. That would involve duplicating sections of the documentation, which can easily cause users to be lost in a sea of mostly similar yet slightly different information.
We're assuming that they're following the documentation from top-down, i.e. it's guaranteed JupyterLab is already installed in the same Python environment before they try to install Jupyter AI. |
@JasonWeill @andrii-i Thank you both for your feedback! I've implemented most of @JasonWeill's suggestions and formatted them in the documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work on this! One minor additional suggestion, otherwise it looks good to go.
Did some manual testing and everything works well. Good job.
It's not clear to me which sections of the documentation would be duplicated that are not currently duplicated. At the same time I don't want to bikeshed / block PR based on this so please feel free to merge if you believe it's more clear this way. |
* initial upgrade to JL4 * fix RTC * update workflows and scripts to JL4 * update documentation to JL4 * pre-commit * update documentation * documentation updates per @JasonWeill
* initial upgrade to JL4 * fix RTC * update workflows and scripts to JL4 * update documentation to JL4 * pre-commit * update documentation * documentation updates per @JasonWeill
Description
Updates the extension to JupyterLab 4. Closes #173.
We are currently debating which release this PR would be included under. This would be released either as 0.11.0 or as 1.0.0.