Skip to content

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

Open
ZayanKhan-12 wants to merge 4 commits into
slackapi:mainfrom
ZayanKhan-12:docs/fix-broken-links
Open

docs: remove links to deleted OAuth examples; fix migration-guide cross-references#2679
ZayanKhan-12 wants to merge 4 commits into
slackapi:mainfrom
ZayanKhan-12:docs/fix-broken-links

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Three commits:

  1. packages/oauth/README.md — the Examples section links ../../examples/oauth-v2 and ../../examples/oauth-v1, but those example apps were removed from the repository (only openid-connect and socket-mode remain), so both links 404. Removed the dead section.
  2. docs/english/oauth.md — the same two examples linked as absolute GitHub URLs; both curl 404 (the parent examples/ tree is 200). Removed.
  3. Migration guides — the web-api v8 guide's requestInterceptor cross-reference was missing the # and used a slug matching no heading (now points at the real #weve-removed-the-requestinterceptor-and-requestinterceptor-types anchor, heading present in the same file), and the socket-mode v3 guide linked ./web-api-v8-migration.md, which doesn't exist anywhere (now ../web-api/migrating-web-api-package-to-v8.md).

Verification: all dead targets confirmed missing (tree + curl), all corrected targets confirmed present; root npm run build and the touched package's suite (npm test --workspace=packages/oauth) pass locally — 16/16 tests (Node 22, macOS arm64).

Prepared with AI assistance (Claude).

zk-khan and others added 3 commits July 26, 2026 20:12
examples/oauth-v2 and examples/oauth-v1 no longer exist in the
repository (only openid-connect and socket-mode remain), so both links
404.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The linked examples/oauth-v2 and examples/oauth-v1 directories were
removed from the repository; both GitHub URLs return 404.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- the requestInterceptor reference was missing the '#' and used a slug
  that matches no heading; point at the actual section anchor
- the socket-mode v3 guide linked ./web-api-v8-migration.md, which does
  not exist; the guide lives at ../web-api/migrating-web-api-package-to-v8.md

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ZayanKhan-12
ZayanKhan-12 requested review from a team as code owners July 27, 2026 00:13
@changeset-bot

changeset-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 18e34df

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@slack/oauth Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@salesforce-cla

Copy link
Copy Markdown

Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement.

@WilliamBergamin WilliamBergamin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this fix 💯

@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.25%. Comparing base (046647f) to head (a335bb5).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2679      +/-   ##
==========================================
+ Coverage   89.11%   89.25%   +0.13%     
==========================================
  Files          65       65              
  Lines       10339    10339              
  Branches      471      471              
==========================================
+ Hits         9214     9228      +14     
+ Misses       1095     1084      -11     
+ Partials       30       27       -3     
Flag Coverage Δ
cli-hooks 89.11% <ø> (ø)
cli-test 89.11% <ø> (ø)
logger 89.11% <ø> (ø)
oauth 89.11% <ø> (ø)
socket-mode 89.11% <ø> (ø)
web-api 89.11% <ø> (ø)
webhook 89.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@lukegalbraithrussell lukegalbraithrussell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs changes are good! Thank you!

@WilliamBergamin

Copy link
Copy Markdown
Contributor

@ZayanKhan-12 these changes are ready to merge 🚀 but I'm unable to merge this until you've signed the CLA

Removed links to deleted OAuth examples and fixed cross-references in the migration guide.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants