docs: instruct virtual environment setup with the slack cli before configuring providers#42
docs: instruct virtual environment setup with the slack cli before configuring providers#42
Conversation
zimeg
changed the title
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
📫 Leaving a note of adjacent lines that can cause confusion for me-
|
|
||
| #### Creating the Slack app | ||
|
|
||
| Use the following command to add your new Slack app to your development workspace. Choose a "local" app environment for upcoming development: |
There was a problem hiding this comment.
🤔 thought: I'm not so confident in the wording here and am open to suggestions! FWIW "local" might be a CLI-specific term at the moment but slackapi/slack-cli#307 might be relevant for upcoming changes!
There was a problem hiding this comment.
We can definitely improve the wording, but at least "local" is aligned with the current CLI output.
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
🐌 Another comment that wasn't sent earlier!
| #### Setup your python virtual environment | ||
|
|
||
| ```sh | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate # for Windows OS, .\.venv\Scripts\Activate instead should work | ||
| ``` | ||
|
|
||
| #### Install dependencies | ||
|
|
||
| ```sh | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
There was a problem hiding this comment.
📚 note: This matches the Quickstart guide and mirrors a section below for "Terminal" setup at this time.
| ``` | ||
|
|
||
| After the Slack app has been created you're all set to configure the LLM provider! | ||
| After the Slack app has been created you're all set to [configure the LLM provider](#providers)! |
mwbrooks
left a comment
mwbrooks
left a comment
There was a problem hiding this comment.
✅ Thanks for the improvements around the Python virtual environment setup!
| ```sh | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate # for Windows OS, .\.venv\Scripts\Activate instead should work | ||
| ``` |
There was a problem hiding this comment.
suggestion: For readability, we could put the Windows suggestion on a different line.
| ```sh | |
| python3 -m venv .venv | |
| source .venv/bin/activate # for Windows OS, .\.venv\Scripts\Activate instead should work | |
| ``` | |
| ```sh | |
| python3 -m venv .venv | |
| source .venv/bin/activate | |
| # Windows OS can run: | |
| # .\.venv\Scripts\Activate |
|
|
||
| #### Creating the Slack app | ||
|
|
||
| Use the following command to add your new Slack app to your development workspace. Choose a "local" app environment for upcoming development: |
There was a problem hiding this comment.
We can definitely improve the wording, but at least "local" is aligned with the current CLI output.
3 participants
Type of change
Summary
This PR updates the
READMEto include virtual environment setup steps with the Slack CLI as well as linking ahead to the section for "providers" once this is complete.Requirements