Commit ad6d05c
authored
docs: sync documentation with current API (automated) (#1639)
## Summary
Automated documentation drift fix. 2 findings addressed (1 P1 · 1 P2).
## Changes
- `EXAMPLES.md` — fixed wrong variable `voiceEnrollment` →
`emailEnrollment` 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)
<details>
<summary>Full Drift Report</summary>
| # | 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 |
</details>
---
🤖 Generated with
[syncing-docs](https://github.com/atko-cic/claude-marketplace) skill
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent 864593c commit ad6d05c
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
676 | 676 | | |
677 | 677 | | |
678 | 678 | | |
| 679 | + | |
| 680 | + | |
679 | 681 | | |
680 | 682 | | |
681 | 683 | | |
| |||
1456 | 1458 | | |
1457 | 1459 | | |
1458 | 1460 | | |
1459 | | - | |
1460 | | - | |
1461 | | - | |
| 1461 | + | |
1462 | 1462 | | |
1463 | 1463 | | |
1464 | 1464 | | |
| |||
0 commit comments