Skip to content

docs: sync documentation with current API (automated)#842

Merged
cschetan77 merged 2 commits into
masterfrom
docs/sync-2026-06-29
Jun 30, 2026
Merged

docs: sync documentation with current API (automated)#842
cschetan77 merged 2 commits into
masterfrom
docs/sync-2026-06-29

Conversation

@sanchitmehtagit

Copy link
Copy Markdown
Contributor

Summary

Automated documentation drift fix. 3 findings addressed (2 P1 · 1 P2).

Changes

  • EXAMPLES.md — replaced jose.JWT.decode() (jose v2 API, removed in jose v6) with decodeJwt named import; added v3 afterCallback behavior callout (P1: breaks at runtime on v3)
  • README.md — added httpAgent removal notice with pointer to customFetch/ProxyAgent migration path (P2: silent runtime no-op for v2 upgraders)
Full Drift Report
# Severity File Line Issue
1 P1 EXAMPLES.md 265 jose.JWT.decode() is jose v2 API — removed in jose v6 (current dependency). Use decodeJwt named export instead
2 P1 EXAMPLES.md ~275 afterCallback v3 behavior change not documented — req.oidc now reflects incoming user, not prior session
3 P2 README.md httpAgent removed in v3 with no notice; customFetch is the replacement

🤖 Generated with syncing-docs skill

@sanchitmehtagit sanchitmehtagit requested a review from a team as a code owner June 29, 2026 06:19
@cschetan77 cschetan77 merged commit 95ee991 into master Jun 30, 2026
35 of 39 checks passed
@cschetan77 cschetan77 deleted the docs/sync-2026-06-29 branch June 30, 2026 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants