Skip to content

Commit 42cf39f

Browse files
committed
docs: align wording with docs.slack.dev
1 parent a8389b1 commit 42cf39f

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,19 @@ black .
7272

7373
### `/listeners`
7474

75-
Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/events` handles incoming events, `/listeners/shortcuts` would handle incoming [Shortcuts](https://docs.slack.dev/interactivity/implementing-shortcuts/) requests, and so on.
76-
77-
**Note**: The `listeners/events` folder is purely educational and demonstrates alternative implementation approaches. These listeners are **not registered** and are not used in the actual application. For the working implementation, refer to `listeners/assistant.py`.
75+
Every incoming request is routed to a "listener". This directory groups each listener based on the Slack Platform feature used, so `/listeners/events` handles incoming events, `/listeners/shortcuts` would handle incoming [Shortcuts](https://docs.slack.dev/interactivity/implementing-shortcuts/) requests, and so on.
7876

77+
:::info[The `listeners/events` folder is purely educational and demonstrates alternative approaches to implementation]
78+
These listeners are **not registered** and are not used in the actual application. For the working implementation, refer to `listeners/assistant.py`.
7979
**`/listeners/assistant`**
8080

8181
Configures the new Slack Assistant features, providing a dedicated side panel UI for users to interact with the AI chatbot. This module includes:
8282

83-
`assistant.py`
84-
* `@assistant.thread_started` - Receives an event when users start new app thread.
85-
* `@assistant.user_message` - Processes user messages in app threads or from the app **Chat** and **History** tab.
86-
87-
`llm_caller.py`
88-
* Handles OpenAI API integration and message formatting. Includes the `call_llm()` function that sends conversation threads to OpenAI's models and converts markdown responses to Slack-compatible formatting.
83+
`assistant.py`, which contains two listeners:
84+
* The `@assistant.thread_started` listener receives an event when users start new app thread.
85+
* The `@assistant.user_message` listener processes user messages in app threads or from the app **Chat** and **History** tab.
8986

87+
`llm_caller.py`, which handles OpenAI API integration and message formatting. It includes the `call_llm()` function that sends conversation threads to OpenAI's models and converts markdown responses to Slack-compatible formatting.
9088

9189
## App Distribution / OAuth
9290

0 commit comments

Comments
 (0)