Skip to content

docs: add cli setup steps#26

Merged
zimeg merged 4 commits intomainfrom
ale-docs/cli-setup-steps
Nov 4, 2025
Merged

docs: add cli setup steps#26
zimeg merged 4 commits intomainfrom
ale-docs/cli-setup-steps

Conversation

@srtaalej
Copy link
Copy Markdown
Contributor

Type of change

  • New feature
  • Bug fix
  • Documentation

Summary

this PR updates the README with CLI setup steps

Requirements

  • I have ensured the changes I am contributing align with existing patterns and have tested and linted my code
  • I've read and agree to the Code of Conduct

@srtaalej srtaalej self-assigned this Oct 21, 2025
@srtaalej srtaalej added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 21, 2025
@srtaalej srtaalej requested review from mwbrooks and zimeg and removed request for zimeg October 21, 2025 19:45
Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

@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...

Comment thread 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

📚 praise: Thanks for bringing improvement alongside these changes!

Comment thread README.md
#### Initializing the project

```sh
slack create my-bolt-python-assistant --template slack-samples/bolt-python-assistant-template
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🐍 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!

@zimeg zimeg merged commit efd12d6 into main Nov 4, 2025
2 checks passed
@zimeg zimeg deleted the ale-docs/cli-setup-steps branch November 4, 2025 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants