Skip to content

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

Merged
sanchitmehtagit merged 2 commits into
mainfrom
docs/sync-2026-06-29
Jul 6, 2026
Merged

docs: sync documentation with current API (automated)#1639
sanchitmehtagit merged 2 commits into
mainfrom
docs/sync-2026-06-29

Conversation

@sanchitmehtagit

@sanchitmehtagit sanchitmehtagit commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

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

Changes

  • EXAMPLES.md — fixed wrong variable voiceEnrollmentemailEnrollment in the "Enrolling Email" MFA section (P1: ReferenceError if copy-pasted without the voice section)
  • EXAMPLES.md — upgraded inline exchangeToken() deprecation comment to a visible Markdown callout (P2: deprecated since v2.14.0 with no visible notice)
Full Drift Report
# Severity File Line Issue
1 P1 EXAMPLES.md 1308 Wrong variable voiceEnrollment.oobCode in Enrolling Email section — should be emailEnrollment.oobCode
2 P2 EXAMPLES.md 525 exchangeToken() deprecated in v2.14.0 but no visible callout block

🤖 Generated with syncing-docs skill

Summary by CodeRabbit

  • Documentation
    • Added a clear deprecation notice for exchangeToken(), with guidance to use loginWithCustomTokenExchange() instead.
  • Bug Fixes
    • Corrected the Email MFA enrollment example so it uses the proper enrollment data and removes an incorrect line.

@sanchitmehtagit sanchitmehtagit requested a review from a team as a code owner June 29, 2026 06:19
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e55f09af-f305-4110-90f0-68d8f20a3e40

📥 Commits

Reviewing files that changed from the base of the PR and between 864593c and 791eb56.

📒 Files selected for processing (1)
  • EXAMPLES.md

📝 Walkthrough

Walkthrough

This PR updates EXAMPLES.md documentation only: it adds a deprecation notice for exchangeToken() recommending loginWithCustomTokenExchange(), and corrects a variable reference (emailEnrollment.oobCode) in the MFA email enrollment code snippet.

Changes

Documentation corrections

Layer / File(s) Summary
Deprecation note and snippet fix
EXAMPLES.md
Adds a deprecation callout for exchangeToken() pointing to loginWithCustomTokenExchange(), and corrects the oobCode variable to emailEnrollment.oobCode in the MFA email enrollment example.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation sync and matches the main change set.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-2026-06-29

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sanchitmehtagit sanchitmehtagit merged commit ad6d05c into main Jul 6, 2026
20 checks passed
@sanchitmehtagit sanchitmehtagit deleted the docs/sync-2026-06-29 branch July 6, 2026 09:56
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