-
Notifications
You must be signed in to change notification settings - Fork 254
Improve the discoverability of examples documentation for better DX #1062
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
README.md
Outdated
|
|
||
| ### Retrieve stored credentials | ||
|
|
||
| The credentials will be automatically renewed (if expired) using the refresh token. |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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.
📋 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:
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