Skip to content

Commit

Permalink
docs: replace indirect links to internal references
Browse files Browse the repository at this point in the history
  • Loading branch information
zimeg committed Dec 13, 2024
1 parent 24491da commit 31049f3
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/content/packages/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ app.get('/slack/oauth_redirect', (req, res) => {

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#callbackoptions) and [`InstallPathOptions`](reference/oauth#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.

For example, you may wish to store some information relevant to your application in a cookie before starting the OAuth flow and redirecting the user to the slack.com authorize URL. Once the user completes the authorization process on slack.com and is redirected back to your application, you can read this cookie and determine if the user has the appropriate permissions to proceed with installation of your application:

Expand Down Expand Up @@ -248,6 +248,7 @@ app.get('/slack/oauth_redirect', (req, res) => {
});
```
</details>

---

### Storing installations in a database
Expand Down
4 changes: 2 additions & 2 deletions docs/content/packages/rtm-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ const rtm = new RTMClient(token, options);

### Custom WebClient

In some cases, you might want to customize the underlying component making HTTP requests to the Slack API, the [`WebClient`](reference/web-api#webclient), beyond the provided [`RTMClientOptions`](reference/rtm-api#rtmclientoptions). Note that overriding the [`WebClient`](reference/web-api#webclient) instance takes precedence over any other [`RTMClientOptions`](reference/rtm-api#rtmclientoptions) specified.
In some cases, you might want to customize the underlying component making HTTP requests to the Slack API, the [`WebClient`](/reference/web-api/classes/WebClient), beyond the provided [`RTMClientOptions`](/reference/rtm-api/interfaces/RTMClientOptions). Note that overriding the [`WebClient`](/reference/web-api/classes/WebClient) instance takes precedence over any other [`RTMClientOptions`](/reference/rtm-api/interfaces/RTMClientOptions) specified.

```javascript
const { RTMClient } = require('@slack/rtm-api');
Expand Down Expand Up @@ -674,7 +674,7 @@ The client can receive a snapshot of a portion of the workspace's state while it
app needs to keep track of some data as it changes while the app runs, but it needs the initial start to get started.
However, **this can also cause the client to fail to connect on large teams**. Our recommendation is to call the [Web
API](/web-api) to retrieve workspace state while your app is connecting, instead of
relying on the cache. See [sending rich messages](#send-messages) for an example of using the `WebClient` class inside
relying on the cache. See [send rich messages](#send-a-message) for an example of using the `WebClient` class inside
your app, and use [some of the other methods](https://api.slack.com/methods) to get data.

If you're certain that you'd like to receive the snapshot, you can set the `useRtmConnect` option to `false`. This
Expand Down
2 changes: 1 addition & 1 deletion docs/content/packages/web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This article contains the steps you must follow to get your access token:
3. [Install the app to a workspace](https://api.slack.com/authentication/basics#installing)
4. Finally, [get your access token](https://api.slack.com/authentication/basics#getting-your-authentication-token)

You can also read the [Getting Started guide](../getting-started) which guides
You can also read the [Getting Started guide](/getting-started) which guides
you through creating an app, retrieving an access token, and using this `@slack/web-api`
package to post a message.

Expand Down

0 comments on commit 31049f3

Please sign in to comment.