Missing Statement of Goals and User Documentation - "Getting Started", "Next steps", etc.

[richlysakowski]

Perhaps it is because this is a brand-new project, but there is not enough information for learn what this is supposed to do, and not enough for me to get started using, testing, or contributing to this.

I see several subrepositories, but those have no descriptions either, only links to themselves and the top-level repo. It looks like just a project template with some project stub repos. It is not (yet) for Python users, because almost all of the code is written in Typescript. (https://github.com/jupyterlab/jupyter-ai/tree/main/packages)

Can someone create a statement of goals, status, and initial user documentation?

That will help people learn how to use it and possibly contribute to it.

Thank you.

Rich Lysakowski

[welcome]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[brian-from-quantrocket]

There is a demo of the functionality in this pull request.

The project maintainers have acknowledged the need for documentation in another issue but this is a work in progress. Give it time.

I was able to get the extension installed and working with ChatGPT by following the instructions found here, with the following modifications:

• Instead of pip install jupyter_ai you should pip install jupyter_ai jupyter_ai_chatgpt
• Instead of setting c.GPT3ModelEngine.api_key, you should set c.ChatGptModelEngine.api_key

The idea of the project is that it can support more than one AI engine, so you're installing both the wrapper project and one or more engines to use.

[dlqqq]

@richlysakowski Yes, we are working on getting this project documented ASAP. We're allocating more effort towards this project to bring it to a more presentable and user-friendly state; this project is still very much in early development.

@brian-from-quantrocket Thank you for your kind words.

[dlqqq]

I've been hesitant to add documentation thus far because there's been a lot of design changes so far, so I wanted to minimize the redundant effort involved with making design changes and then correcting all of the docs.

[JasonWeill]

Documentation is a work in progress: follow issue #21. Thank you for your interest!

[JasonWeill]

User documentation is now live on ReadTheDocs: https://jupyter-ai.readthedocs.io/en/latest/

I'd love to hear your feedback on it!

[JasonWeill]

Closing because #21 is complete; please file additional enhancements if you have suggestions to improve the docs.