docs: add cli setup steps #26
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
srtaalej
added
documentation
srtaalej
requested review from
mwbrooks and
zimeg
and removed request for
zimeg
3 tasks
zimeg
approved these changes
Nov 4, 2025
Member
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
@srtaalej Thanks for bringing this README to standard 🫡
I made a few small changes on heading "importance" and file paths but think we should merge this! I left a comment around virtual environments and the CLI that we might consider revisiting soon...
README.md
Outdated
Comment on lines
88
to
90
| `assistant.py`, which contains two listeners: | ||
| * The `@assistant.thread_started` listener receives an event when users start new app thread. | ||
| * The `@assistant.user_message` listener processes user messages in app threads or from the app **Chat** and **History** tab. |
Member
There was a problem hiding this comment.
📚 praise: Thanks for bringing improvement alongside these changes!
| #### Initializing the project | ||
|
|
||
| ```sh | ||
| slack create my-bolt-python-assistant --template slack-samples/bolt-python-assistant-template |
Member
There was a problem hiding this comment.
🐍 note: Additional steps are output related to setting up a virtual environment with the current version of this command. I think it's alright to not include these steps here with plans of enhancement upstream!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Summary
this PR updates the README with CLI setup steps
Requirements