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.

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

Chat help message on load #277

Merged
merged 14 commits into from
Jul 22, 2023
Merged

Conversation

JasonWeill
Copy link
Collaborator

@JasonWeill JasonWeill commented Jul 19, 2023

On initial load, or after running /help, Jupyternaut now sends a helpful message to the user.

Fixes #93. This change also applies minor copy edits to the initial config message. It shortens the chat box placeholder from "Ask JupyterLab anything" to "Ask JupyterLab", so that it no longer appears on two lines at the default width of the left panel.

initial-help-message

@JasonWeill JasonWeill added enhancement New feature or request @jupyter-ai/chatui labels Jul 19, 2023
@ellisonbg
Copy link
Contributor

This is great - minor feedback. I think the use of the word "send" in the text is a little awkward and technical in this context. I would more phrase this in human terms using phrases like "ask me a question", "chat with me", etc.

@andrii-i
Copy link
Collaborator

andrii-i commented Jul 21, 2023

Overall looks and reads well, good job. Couple of points that would improve look and usability from my POV:

  1. Bulletpoint + padding on the left uses too much of the limited space. Remove bulletpoints or decrease padding on the left so that text/bullet would line up with the rest of the text horizontally:
image

2. Make suggested commands clickable hyperlinks that send command to chat. This way first-time users could try commands with 1 click covered by #280

@andrii-i
Copy link
Collaborator

andrii-i commented Jul 21, 2023

AI magics are really powerful but are also unique (not something user would know about by default) and not easily discoverable. You can't install a chat panel without installing AI magics so I think it would be good to add a short paragraph about AI magics to the chat placeholder and provide a link to the docs section about them.

from .base import BaseChatHandler

HELP_MESSAGE = """Hi there! I'm Jupyternaut, your programming assistant.
You can ask me a question using the text box below. You can also send me commands:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JasonWeill
In line with @ellisonbg's comments, do you want to rephrase this section.

Suggested change
You can ask me a question using the text box below. You can also send me commands:
You can ask me a question using the text box below. You can also use these slash commands:

@JasonWeill
Copy link
Collaborator Author

Updates per feedback from @andrii-i , @3coins , and @ellisonbg . New screen shot:

Screen Shot 2023-07-21 at 1 43 31 PM

@JasonWeill JasonWeill merged commit 0afca1c into jupyterlab:main Jul 22, 2023
3 checks passed
dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
* Shortens text box placeholder

* Adds help command

* Adds link to docs

* Simplifies help handler

* Initial help message on load

* Reverts changes to default.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Copy edit: send -> ask

* Update packages/jupyter-ai/jupyter_ai/chat_handlers/help.py

Co-authored-by: Piyush Jain <[email protected]>

* Simplifies reply logic

* Tightens spacing for bulleted lists in markdown

* Slash commands, mentions magic commands

* Plural notebooks

* Update packages/jupyter-ai/jupyter_ai/chat_handlers/help.py

Co-authored-by: Andrii Ieroshenko <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <[email protected]>
Co-authored-by: Andrii Ieroshenko <[email protected]>
Marchlak pushed a commit to Marchlak/jupyter-ai that referenced this pull request Oct 28, 2024
* Shortens text box placeholder

* Adds help command

* Adds link to docs

* Simplifies help handler

* Initial help message on load

* Reverts changes to default.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Copy edit: send -> ask

* Update packages/jupyter-ai/jupyter_ai/chat_handlers/help.py

Co-authored-by: Piyush Jain <[email protected]>

* Simplifies reply logic

* Tightens spacing for bulleted lists in markdown

* Slash commands, mentions magic commands

* Plural notebooks

* Update packages/jupyter-ai/jupyter_ai/chat_handlers/help.py

Co-authored-by: Andrii Ieroshenko <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <[email protected]>
Co-authored-by: Andrii Ieroshenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request @jupyter-ai/chatui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Initial message/placeholder in chat panel
4 participants