Skip to content

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

Draft
sanchitmehtagit wants to merge 4 commits into
mainfrom
docs/sync-2026-06-24
Draft

docs: fix README drift — broken DPoP link, stale What's New banner, stale migration notice#878
sanchitmehtagit wants to merge 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

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 17d8cea0-b1e2-43d0-a30c-eff7d8adbe47

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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.

…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
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.

1 participant