Skip to content

docs: remove links to deleted OAuth examples; fix migration-guide cross-references #2679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZayanKhan-12 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: remove links to deleted OAuth examples; fix migration-guide cross-references #2679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2bf5ac8
oauth: remove Examples section pointing at deleted example apps
zk-khan Jul 27, 2026
42fa1a6
docs: remove OAuth examples links to deleted example apps
zk-khan Jul 27, 2026
a335bb5
docs: fix broken cross-references in migration guides
zk-khan Jul 27, 2026
18e34df
Update documentation for OAuth examples and migration guide
ZayanKhan-12 Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/sweet-badgers-remain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/oauth": patch
---

docs: remove links to deleted OAuth examples; fix migration-guide cross-references
2 changes: 1 addition & 1 deletion docs/english/migration/socket-mode/migrating-socket-mode-package-to-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const client = new SocketModeClient({

### We've updated the dependency on `@slack/web-api@^8`

This package now uses `@slack/web-api@^8` internally. If you're passing `clientOptions`, the web-api breaking changes apply there too. Check the [web-api v8 migration guide](./web-api-v8-migration.md) for details.
This package now uses `@slack/web-api@^8` internally. If you're passing `clientOptions`, the web-api breaking changes apply there too. Check the [web-api v8 migration guide](../web-api/migrating-web-api-package-to-v8.md) for details.

```diff
const client = new SocketModeClient({
Expand Down
2 changes: 1 addition & 1 deletion docs/english/migration/web-api/migrating-web-api-package-to-v8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ function handleError(error: WebAPIHTTPError) {

### We've removed the `RequestConfig` type

The `RequestConfig` type was an alias for axios's `InternalAxiosRequestConfig`. If you were importing it for `requestInterceptor`, [that has also been removed](requestinterceptor-and-requestinterceptor-type-removed). Use a fetch wrapper instead as described above.
The `RequestConfig` type was an alias for axios's `InternalAxiosRequestConfig`. If you were importing it for `requestInterceptor`, [that has also been removed](#weve-removed-the-requestinterceptor-and-requestinterceptor-types). Use a fetch wrapper instead as described above.

```diff
-import type { RequestConfig } from '@slack/web-api';
Expand Down
6 changes: 0 additions & 6 deletions docs/english/oauth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,12 +463,6 @@ const installer = new InstallProvider({
```
</details>

---

## Examples

* [OAuth Express app](https://github.com/slackapi/node-slack-sdk/tree/main/examples/oauth-v2/README.md). This example uses [Keyv](https://github.com/lukechilds/keyv) library as an installation store.
* [Classic Slack app](https://github.com/slackapi/node-slack-sdk/tree/main/examples/oauth-v1/README.md). This example uses the built-in installation store.

---

Expand Down
6 changes: 0 additions & 6 deletions packages/oauth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,12 +388,6 @@ const installer = new InstallProvider({
```
</details>

---

### Examples

* [OAuth Express app](../../examples/oauth-v2/README.md). This example uses [Keyv](https://github.com/lukechilds/keyv) library as an installation store.
* [classic Slack App](../../examples/oauth-v1/README.md). This example uses the built-in installation store

---

Expand Down