Skip to content

Conversation

@sanchitmehta94
Copy link
Contributor

@sanchitmehta94 sanchitmehta94 commented Jan 6, 2026

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

📋 Changes

Previously, EXAMPLES.md contained comprehensive code samples but was nested deep within the README, making it easy for users to miss.

This change improves discoverability by:

  1. Adding a dedicated “Examples” section in the top navigation, placed next to Getting Started
  2. Introducing a clearly labeled Examples header (with icon) that links directly to the examples section
  3. Surfacing key Swift SDK examples directly in README.md for quick access
  4. Providing a clear link to the full EXAMPLES.md document for deeper reference at the bottom of example section this makes the better discoverable linking to Example.md file

This structure makes examples easier to find, faster to scan, and more approachable—improving the overall developer experience

📎 References

🎯 Testing

https://github.com/auth0/Auth0.swift/tree/DX/improvements

@sanchitmehta94 sanchitmehta94 requested a review from a team as a code owner January 6, 2026 14:10
@sanchitmehta94 sanchitmehta94 changed the title DX: Improve the discoverability of examples documentation fil Improve the discoverability of examples documentation for better DX Jan 6, 2026
README.md Outdated

### Retrieve stored credentials

The credentials will be automatically renewed (if expired) using the refresh token.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think this sentence can be improved. Somethinkg like:
" Retrieve the stored credentials from the Keychain. If the credentials have expired, they will be automatically renewed using the refresh token"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


### Clear stored credentials

The stored credentials can be removed from the Keychain by using the `clear()` method.
Copy link
Contributor

@pmathew92 pmathew92 Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a note also saying something like
"It is recommended to clear all saved credentials when the user logs out of the application"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, Added a note recommending this API be called on logout.
Currently, there is no API to clear the APICredentials introduced for the MRRT flow. having a unified clear-all API which a breaking change, planned in the next major Swift release.

NandanPrabhu
NandanPrabhu previously approved these changes Jan 7, 2026
@sanchitmehta94 sanchitmehta94 enabled auto-merge (squash) January 7, 2026 07:26
@sanchitmehta94 sanchitmehta94 merged commit 59815c5 into master Jan 7, 2026
33 of 36 checks passed
@sanchitmehta94 sanchitmehta94 deleted the DX/improvements branch January 7, 2026 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review:small Small review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants