docs: update links, copy edit, apply style guide #2294
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
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #2294 +/- ##
==========================================
- Coverage 92.71% 92.69% -0.02%
==========================================
Files 38 38
Lines 10607 10609 +2
Branches 683 683
==========================================
Hits 9834 9834
- Misses 761 763 +2
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
README.md
Outdated
| walk you through building your first Slack app using Node.js. | ||
|
|
||
| | Slack API | What its for | NPM Package | | ||
| | Slack API | What it's for | NPM Package | |
Contributor
There was a problem hiding this comment.
Suggested change
| | Slack API | What it's for | NPM Package | | |
| | Slack API | Use | NPM Package | |
README.md
Outdated
| |--------------|--------------|-------------------| | ||
| | Web API | Send data to or query data from Slack using any of [over 220 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) | | ||
| | Web API | Send data to or query data from Slack using any of [over 220 methods](https://docs.slack.dev/reference/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) | | ||
| | OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) | |
Contributor
There was a problem hiding this comment.
Suggested change
| | OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) | | |
| | OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) | |
|
|
||
| The Node Slack SDK has corresponding packages for Slack APIs. They are small and powerful when used independently, and work seamlessly when used together, too. | ||
|
|
||
| | Slack API | Use | NPM package | |
Contributor
There was a problem hiding this comment.
i did an above edit to match this
docs/content/index.md
Outdated
| `@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed. | ||
|
|
||
| At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](/tutorials/migrating-to-v6) for those looking to convert their existing apps. | ||
| At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). |
Contributor
There was a problem hiding this comment.
Suggested change
| At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). | |
| At this time, we recommend migrating to [Bolt for JavaScript](https://tools.slack.dev/bolt-js), a framework that offers all of the functionality available in those packages (and more). |
Comment on lines
16
to
17
| The `@slack/interactive-messages` helps your app respond to interactions from the Slack | ||
| [interactive messages](https://docs.slack.dev/interactivity), [actions](https://docs.slack.dev/interactivity/implementing-shortcuts), and [modals](https://docs.slack.dev/interactivity/adding-interactive-modals-to-home-tab). This package will help you start with convenient and secure defaults. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `@slack/interactive-messages` helps your app respond to interactions from the Slack | |
| [interactive messages](https://docs.slack.dev/interactivity), [actions](https://docs.slack.dev/interactivity/implementing-shortcuts), and [modals](https://docs.slack.dev/interactivity/adding-interactive-modals-to-home-tab). This package will help you start with convenient and secure defaults. | |
| The `@slack/interactive-messages` helps your app respond to interactions from [interactive messages](https://docs.slack.dev/interactivity), [actions](https://docs.slack.dev/interactivity/implementing-shortcuts), and [modals](https://docs.slack.dev/interactivity/adding-interactive-modals-to-home-tab) in Slack. This package will help you start with convenient and secure defaults. |
| ``` | ||
|
|
||
| When choosing to turn late response fallback off, its important to stop relying on returning `Promise`s from handler | ||
| When choosing to turn late response fallback off, it's important to stop relying on returning `Promise`s from handler |
Contributor
There was a problem hiding this comment.
Suggested change
| When choosing to turn late response fallback off, it's important to stop relying on returning `Promise`s from handler | |
| When choosing to turn late response fallback off, it's important to stop relying on returning a `Promise` from the handler |
plurals are weird looking to me
docs/content/packages/oauth.md
Outdated
| There are many situations where you may want to persist some custom data relevant to your application across the entire OAuth flow. For example, you may want to map Slack resources (like users) to your own application's resources, or verify and gate eligibility for proceeding with installing your Slack application to a workspace based on your application's requirements. To this end, this package provides a series of hooks, or callbacks, that allow your application to integrate throughout key points of the OAuth flow. | ||
|
|
||
| These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces - check their [reference documentation](reference/oauth) for more details. | ||
| These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces—check their [reference documentation](reference/oauth) for more details. |
Contributor
There was a problem hiding this comment.
Suggested change
| These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces—check their [reference documentation](reference/oauth) for more details. | |
| These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces—check their [reference documentation](reference/oauth) for more details. |
i am dying on this hill
docs/content/packages/socket-mode.md
Outdated
| ``` | ||
|
|
||
| When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://tools.slack.dev/bolt-js/concepts#socket-mode). | ||
| When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://tools.slack.dev/bolt-js/concepts/socket-mode). |
Contributor
There was a problem hiding this comment.
Suggested change
| When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://tools.slack.dev/bolt-js/concepts/socket-mode). | |
| When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt for JavaScript Socket Mode docs](https://tools.slack.dev/bolt-js/concepts/socket-mode). |
Contributor
There was a problem hiding this comment.
"documentation" is my father's name
| If you want your app to be subscribed to workspace events (like when a reaction is added, when a user mentions your app, or [another Events API event](https://docs.slack.dev/reference/events)), you need to enable events for your app. | ||
|
|
||
| Start by clicking **Event Subscriptions** on the left sidebar. If your app is using HTTP to communicate with Slack, after you toggle the switch, you'll need to add a Request URL. This is similar to [adding a Request URL in the **Interactive Components** section](#what-is-a-request-url), but as described on this page, Slack will issue a `challenge` request to verify that your app's request URL can respond appropriately to incoming requests. Read through our [Request URL Configuration & Verification](https://api.slack.com/apis/connections/events-api#the-events-api__subscribing-to-event-types__events-api-request-urls__request-url-configuration--verification) documentation for details on how to properly handle a `challenge` request. | ||
| Start by clicking **Event Subscriptions** on the left sidebar. If your app is using HTTP to communicate with Slack, after you toggle the switch, you'll need to add a Request URL. This is similar to [adding a Request URL in the **Interactive Components** section](#what-is-a-request-url), but as described on this page, Slack will issue a `challenge` request to verify that your app's request URL can respond appropriately to incoming requests. Read through our [Request URL Configuration & Verification](https://docs.slack.dev/apis/events-api#subscribing) documentation for details on how to properly handle a `challenge` request. |
Contributor
There was a problem hiding this comment.
Suggested change
| Start by clicking **Event Subscriptions** on the left sidebar. If your app is using HTTP to communicate with Slack, after you toggle the switch, you'll need to add a Request URL. This is similar to [adding a Request URL in the **Interactive Components** section](#what-is-a-request-url), but as described on this page, Slack will issue a `challenge` request to verify that your app's request URL can respond appropriately to incoming requests. Read through our [Request URL Configuration & Verification](https://docs.slack.dev/apis/events-api#subscribing) documentation for details on how to properly handle a `challenge` request. | |
| Start by clicking **Event Subscriptions** on the left sidebar. If your app is using HTTP to communicate with Slack, after you toggle the switch, you'll need to add a Request URL. This is similar to [adding a Request URL in the **Interactive Components** section](#what-is-a-request-url), but as described on this page, Slack will issue a `challenge` request to verify that your app's request URL can respond appropriately to incoming requests. Read through our [Request URL Configuration & Verification](https://docs.slack.dev/apis/events-api#subscribing) documentation for details on how to properly handle a `challenge` request. |
packages/rtm-api/README.md
Outdated
| are more attractive and useful for users of your app. Install and import the `@slack/web-api` package into your app, | ||
| initialize the `WebClient` class, and use the `.chat.postMessage(options)` method to send a rich message. The example | ||
| above can be rewritten using the following code: | ||
| The Web API's [`chat.postMessage` method](https://docs.slack.dev/reference/methods/chat.postMessage) is capable of sending [rich messages](https://docs.slack.dev/messaging/formatting-message-text) more advanced layout and interactions. These rich messages are more attractive and useful for users of your app. Install and import the `@slack/web-api` package into your app, initialize the `WebClient` class, and use the `.chat.postMessage(options)` method to send a rich message. The example above can be rewritten using the following code: |
Contributor
There was a problem hiding this comment.
Suggested change
| The Web API's [`chat.postMessage` method](https://docs.slack.dev/reference/methods/chat.postMessage) is capable of sending [rich messages](https://docs.slack.dev/messaging/formatting-message-text) more advanced layout and interactions. These rich messages are more attractive and useful for users of your app. Install and import the `@slack/web-api` package into your app, initialize the `WebClient` class, and use the `.chat.postMessage(options)` method to send a rich message. The example above can be rewritten using the following code: | |
| The [`chat.postMessage`](https://docs.slack.dev/reference/methods/chat.postMessage) Web API method is capable of sending [rich messages](https://docs.slack.dev/messaging/formatting-message-text) more advanced layout and interactions. These rich messages are more attractive and useful for users of your app. Install and import the `@slack/web-api` package into your app, initialize the `WebClient` class, and use the `.chat.postMessage(options)` method to send a rich message. The example above can be rewritten using the following code: |
lukegalbraithrussell
approved these changes
Jul 8, 2025
Contributor
lukegalbraithrussell
left a comment
There was a problem hiding this comment.
docs are good, left some minor comments. do what you will with those
zimeg
approved these changes
Jul 11, 2025
Member
zimeg
left a comment
There was a problem hiding this comment.
@haleychaas LGTM and huge thanks for all of these improvements - I'm a fan of the copy edits with style guide 📚 ✨
All of the changes are solid to land whenever the time is right! We'll make sure to highlight this with the package releases 🤖
I left one comment with a suggested space to add but it's no blocker. The changes are a huge boost to these docs 🚀
| `@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed. | ||
|
|
||
| At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](/tutorials/migrating-to-v6) for those looking to convert their existing apps. | ||
| At this time, we recommend migrating to [Bolt for JavaScript](https://tools.slack.dev/bolt-js), a framework that offers all of the functionality available in those packages (and more). |
|
|
||
| --- | ||
|
|
||
| ### Initialize the event adapter |
Comment on lines
-17
to
-18
| --- | ||
|
|
Comment on lines
+975
to
+977
| logger.warn( | ||
| `${method} is deprecated. Please check on https://docs.slack.dev/reference/methods for an alternative.`, | ||
| ); |
Member
There was a problem hiding this comment.
📠 This is a wonderful change for upcoming releases!
Member
There was a problem hiding this comment.
🏆 Incredible changes all throughout.
| * @description Pass `true` to act as the authed user with {@link https://docs.slack.dev/reference/scopes/chat.write `chat:write:user` scope}. | ||
| * Bot users in this context are considered authed users. If unused or `false`, the message will be acted upon with | ||
| * {@link https://api.slack.com/scopes/chat:write:bot `chat:write:bot` scope}. | ||
| * {@link https://docs.slack.dev/reference/scopes/chat.write `chat:write:bot` scope}. |
Member
|
🗣️ Let's ignore the @codecov checks for now also - that shouldn't be blocking this from shipping! |
Member
|
📣 FWIW the more unexpected |
Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>
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.
Summary
Updates all necessary links from api.slack.com/x to their equivalent on docs.slack.dev. I also did some copy editing and applying guidelines from our style guide. (changes are docs only)
Requirements (place an
xin each[ ])