Skip to content

docs: fix README drift — broken DPoP link, stale What's New banner, stale migration notice#878

Merged
utkrishtsahu merged 4 commits into
mainfrom
docs/sync-2026-06-24
Jun 29, 2026
Merged

docs: fix README drift — broken DPoP link, stale What's New banner, stale migration notice#878
utkrishtsahu merged 4 commits into
mainfrom
docs/sync-2026-06-24

Conversation

@sanchitmehtagit

@sanchitmehtagit sanchitmehtagit commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation drift fixes for auth0-flutter v2.3.0 — audited against the live API surface.

README.md (3 fixes)

  • What's New banner updated from v2.1.0 → v2.3.0 with passkeys callout (P2 — stale hero section)
  • Stale v2.0.0 migration notice removed — 3 versions old, no longer relevant to new developers (P2)
  • Broken DPoP.md link corrected to point to MIGRATION_GUIDE.md (P2)

EXAMPLES.md (3 fixes)

  • Package name typo corrected: flutter_auth0auth0_flutter in Credentials Manager section (P3)
  • Duplicate partial TOC block removed — lines that re-listed Web Auth section headings already present in the full TOC above (P3)
  • Stale My Account API gating note updated: the note said "the API must be enabled — contact support"; in reality only MRRT must be enabled, not the feature itself (P2)

Test plan

  • Verify all markdown links resolve in the GitHub preview
  • Confirm ## What's New: v2.3.0 banner accurately describes passkeys and links to the passkeys docs
  • Confirm no duplicate headings remain in EXAMPLES.md TOC
  • Confirm auth0_flutter package name is used consistently throughout EXAMPLES.md

🤖 Generated with syncing-sdk-docs skill

Summary by CodeRabbit

  • New Features

    • Updated the “What’s New” section to highlight version 2.3.0 and new Passkeys support for web authentication on Android, iOS, and Web.
  • Documentation

    • Refined example docs for clearer web authentication and credentials manager guidance.
    • Clarified the My Account API note about Multi-Resource Refresh Tokens requirements.
    • Updated a documentation link for DPoP guidance.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@utkrishtsahu, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1f19fd53-a492-4027-8470-f4234df78909

📥 Commits

Reviewing files that changed from the base of the PR and between d8cc32a and f5a6a25.

📒 Files selected for processing (2)
  • auth0_flutter/EXAMPLES.md
  • auth0_flutter/README.md

Walkthrough

Updates README.md to replace the "What's New" section with a v2.3.0 passkeys entry and fixes the DPoP link target. Updates EXAMPLES.md to remove a stale Web Authentication TOC bullet list, correct an SDK name typo (flutter_auth0auth0_flutter), and reword the My Account API MRRT requirement note.

Documentation corrections

Layer / File(s) Summary
README: v2.3.0 What's New and DPoP link
auth0_flutter/README.md
Replaces v2.1.0/v2.0.0 What's New content with a v2.3.0 passkeys entry; changes the DPoP "complete documentation" link from DPOP.md to MIGRATION_GUIDE.md.
EXAMPLES: TOC removal, SDK name fix, MRRT note
auth0_flutter/EXAMPLES.md
Removes stale Web Authentication subsection bullet list; corrects flutter_auth0auth0_flutter in Credentials Manager; rewords My Account API note to specify MRRT must be enabled and directs users to Auth0 support.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • auth0/auth0-flutter#852: Introduced MRRT support in v2.2.0, directly related to the MRRT tenant requirement clarification added in EXAMPLES.md.
  • auth0/auth0-flutter#869: v2.3.0 changelog entry for passkeys aligns with the README What's New update adding passkeys via webAuthentication().

Poem

🔑 Passkeys arrive, the changelog is new,
A typo corrected — auth0_flutter rings true.
The DPoP link points where it ought to go,
MRRT requirements spelled out plain and low.
Clean docs, clean SDK — onward we flow! 🚀

🚥 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 main README documentation fixes, including the DPoP link, What’s New banner, and migration notice.
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-24

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.

@utkrishtsahu utkrishtsahu marked this pull request as ready for review June 29, 2026 09:01
@utkrishtsahu utkrishtsahu requested a review from a team as a code owner June 29, 2026 09:01
sanchitmehtagit and others added 4 commits June 29, 2026 14:35
…ating note

- Fix package name typo: flutter_auth0 → auth0_flutter in Credentials
  Manager custom implementation section
- Remove duplicate partial TOC block (lines 59–82 re-listed Web Auth
  section headings that were already in the full TOC above)
- Clarify My Account API setup note: the gating requirement is MRRT
  (Multi-Resource Refresh Tokens), not the My Account API itself —
  the old note incorrectly implied the API feature itself needed to be
  enabled by support, which is no longer accurate
@utkrishtsahu utkrishtsahu force-pushed the docs/sync-2026-06-24 branch from d8cc32a to f5a6a25 Compare June 29, 2026 09:05
@utkrishtsahu utkrishtsahu merged commit 6e8521c into main Jun 29, 2026
6 checks passed
@utkrishtsahu utkrishtsahu deleted the docs/sync-2026-06-24 branch June 29, 2026 09:08
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