Initial docs #22
Initial docs #22
Conversation
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
JasonWeill
added
documentation
|
Kicking CI. |
|
Looks like you forgot to add a |
|
This looks great, and goes into more detail than I had expected. Awesome work. 👍 There is more documentation that needs to be added, most notably IPython magics usage, but we can iterate on those in follow-up PRs. In the "Users" documentation, there are mentions of "plugins", for example:
Please change the wording to use AI modules instead of plugins. Also, a brief explanation of what AI modules are would also help. Here's an outline of what this section should touch on:
|
|
Congrats on your first merged pull request in this project! 🎉 |
|
|
||
| ## Prerequisites | ||
|
|
||
| To use Jupyter AI, you will need to have JupyterLab ≥ 3.5 (*not* JupyterLab 4) installed. |
There was a problem hiding this comment.
need to have JupyterLab ≥ 3.5 (*not* JupyterLab 4) installed is somewhat confusing to me. Would something like need to have JupyterLab version 3.5 or above (but below version 4.0.0) or yarn notation need to have JupyterLab ≥3.5.0 <4.0.0 be more clear?
* Initial docs commit * Change authors * Updates theming, adds image * Removes stray whitespace * Adds basic intro * Removes indices * Switches to Markdown; adds user docs file * Adds user docs * Adds configuration info * Makes URLs into links * Mentions jupyter_ai_chatgpt * Early contributor docs * Adds user docs with screen shots * Adds AI module and task description * Docs on creating a new AI module * Notes that modality and insertion mode are extensible * Adds docs/requirements.txt * Removes colon_fence from requirements * Adds definition of Jupyter AI at top level * Adds image to top level docs * Plugin -> AI modules * "new tasks" are most important of the three
* Initial docs commit * Change authors * Updates theming, adds image * Removes stray whitespace * Adds basic intro * Removes indices * Switches to Markdown; adds user docs file * Adds user docs * Adds configuration info * Makes URLs into links * Mentions jupyter_ai_chatgpt * Early contributor docs * Adds user docs with screen shots * Adds AI module and task description * Docs on creating a new AI module * Notes that modality and insertion mode are extensible * Adds docs/requirements.txt * Removes colon_fence from requirements * Adds definition of Jupyter AI at top level * Adds image to top level docs * Plugin -> AI modules * "new tasks" are most important of the three
Fixes #21.
Initial user and contributor documentation suitable for use with ReadTheDocs.