Skip to content

chore: enriched the documentation#249

Merged
IronTony merged 3 commits intomainfrom
feat/apple-signin-doc-new
Apr 3, 2026
Merged

chore: enriched the documentation#249
IronTony merged 3 commits intomainfrom
feat/apple-signin-doc-new

Conversation

@IronTony
Copy link
Copy Markdown
Member

@IronTony IronTony commented Apr 2, 2026

Affected Package(s)

  • @forward-software/react-auth (lib)
  • @forward-software/react-auth-apple (packages/apple-signin)
  • @forward-software/react-auth-google (packages/google-signin)
  • Examples
  • CI/CD / Repository configuration

Related Issue(s)

None, driven by community feedback on LinkedIn.

Motivation

The README thoroughly documents how to set up Apple Sign-In, but was missing two pieces: what needs ongoing maintenance (renewal cycles, membership dependency) and iOS version-specific behavior. This was flagged by a developer in a LinkedIn discussion.

Description of Changes

  • Added a "Platform Notes" section to the apple-signin README
  • Documented renewal and maintenance details (keys don't expire, membership renewal matters, no certificates to rotate)
  • Documented iOS version notes (iOS 13+ requirement, iOS 15+ credential state improvements, button auto-adaptation)

Breaking Changes

None

How to Test

  1. CI Checks: Verify that all automated tests (Vitest) and build steps pass successfully on this PR.
  2. Local Verification (Optional):
    • Review the README rendering on GitHub to confirm formatting is correct.

Checklist

  • My code follows the project's style guidelines
  • I have added or updated tests to cover the changes
  • I have updated relevant documentation
  • All tests are passing locally
  • CI checks are passing
  • I have reviewed my own code and lock file changes
  • I have checked for any potential security implications
  • I have verified the changes work as expected
  • My commit messages follow Conventional Commits format

Notes for Reviewers

Documentation-only change. No code modified.

@IronTony IronTony requested a review from panz3r April 2, 2026 19:51
@panz3r panz3r requested review from Copilot and removed request for panz3r April 3, 2026 07:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation update for @forward-software/react-auth-apple to add ongoing maintenance and iOS platform-specific notes for Apple Sign-In consumers.

Changes:

  • Added a new “Platform Notes” section to the Apple Sign-In README.
  • Documented renewal/maintenance considerations and iOS version behavior notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@panz3r panz3r added the documentation Improvements or additions to documentation label Apr 3, 2026
@panz3r panz3r self-requested a review April 3, 2026 09:44
panz3r
panz3r previously approved these changes Apr 3, 2026
Copy link
Copy Markdown
Member

@panz3r panz3r left a comment

Choose a reason for hiding this comment

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

Overall LGTM 👍

Have a look at Copilot suggestions and apply the ones you think are most accurate 😉

@IronTony IronTony merged commit ecf65ee into main Apr 3, 2026
16 checks passed
@IronTony IronTony deleted the feat/apple-signin-doc-new branch April 3, 2026 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants