docs: add dev note about auth strategy hot-reload requirement#14122
Merged
Conversation
Contributor
|
Came here to make the same contribution! Would've saved me quite some debugging time if I knew 😂😭 +1! |
paulpopus
approved these changes
Apr 2, 2026
Contributor
|
🚀 This is included in version v3.82.0 |
milamer
pushed a commit
to milamer/payload
that referenced
this pull request
Apr 20, 2026
…dcms#14122) ### What? Added a documentation note informing developers that custom authentication strategies require a full server restart and are not hot-reloaded during development. ### Why? During development, developers may expect auth strategies to hot-reload like other code changes in Payload. When changes don't take effect immediately, it leads to confusion and wasted debugging time trying to figure out why their strategy modifications aren't working. This small documentation addition can save developers significant time and frustration. ### How? - Added an informational `<Banner>` component in `docs/authentication/custom-strategies.mdx` - Placed it immediately after the existing warning banner at the top of the page - Includes a clear note about the restart requirement and suggests using `nodemon` for auto-restart **Before:** Only had the warning banner about this being an advanced feature. **After:** Now includes an additional info banner that explicitly states auth strategies require restart and are not hot-reloaded. Fixes: N/A (proactive documentation improvement)
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
3 participants
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.
What?
Added a documentation note informing developers that custom authentication strategies require a full server restart and are not hot-reloaded during development.
Why?
During development, developers may expect auth strategies to hot-reload like other code changes in Payload. When changes don't take effect immediately, it leads to confusion and wasted debugging time trying to figure out why their strategy modifications aren't working.
This small documentation addition can save developers significant time and frustration.
How?
<Banner>component indocs/authentication/custom-strategies.mdxnodemonfor auto-restartBefore:
Only had the warning banner about this being an advanced feature.
After:
Now includes an additional info banner that explicitly states auth strategies require restart and are not hot-reloaded.
Fixes: N/A (proactive documentation improvement)