docs: Enhance Apple Sign-In setup and configuration documentation#466
Open
docs: Enhance Apple Sign-In setup and configuration documentation#466
Conversation
…roubleshooting documentation
Swiftaxe
reviewed
Apr 15, 2026
There was a problem hiding this comment.
Pull request overview
Enhances the “Sign in with Apple” documentation by adding clearer platform-specific setup guidance, expanding configuration references, and introducing a troubleshooting guide to help diagnose common Apple OAuth and integration failures.
Changes:
- Added a new troubleshooting page (both unversioned and v3.4.0 versioned docs) with a setup checklist and common failure scenarios.
- Expanded the setup guide with platform requirements, Apple Developer Portal screenshots, and additional warnings/gotchas.
- Updated the configuration guide with clearer route parameter notes,
--dart-definefallback details, and anAppleIdpConfigparameter reference.
Reviewed changes
Copilot reviewed 6 out of 14 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md |
Adds platform requirements, screenshots, and additional warnings/gotchas for Apple setup. |
docs/06-concepts/11-authentication/04-providers/04-apple/02-configuration.md |
Expands config docs with route notes, --dart-define fallback info, and AppleIdpConfig reference. |
docs/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md |
New troubleshooting page for common Apple sign-in issues and fixes. |
versioned_docs/version-3.4.0/06-concepts/11-authentication/04-providers/04-apple/01-setup.md |
Mirrors setup doc improvements for the v3.4.0 versioned docs. |
versioned_docs/version-3.4.0/06-concepts/11-authentication/04-providers/04-apple/02-configuration.md |
Mirrors configuration doc improvements for the v3.4.0 versioned docs. |
versioned_docs/version-3.4.0/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md |
Mirrors the new troubleshooting page for the v3.4.0 versioned docs. |
static/img/authentication/providers/apple/5-app-id-capability.png |
Adds/updates an Apple Developer Portal screenshot referenced by the setup docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…providers/04-apple/04-troubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…oubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…providers/04-apple/04-troubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…oubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…oubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…providers/04-apple/04-troubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…oubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…providers/04-apple/04-troubleshooting.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: serverpod/serverpod#4570
Problem
The Sign in with Apple docs lacked screenshots for the Apple Developer Portal setup, had no clear separation between what iOS/macOS, Android, and Web each require, and didn't explain key gotchas (raw
.p8key vs pre-generated JWT, HTTPS-only redirect URIs, YAML indentation). There was also no troubleshooting page.Solution
AppleIdpConfigparameter reference.