Skip to content

Commit c4da453

Browse files
authored
docs: add dev note about auth strategy hot-reload requirement (#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)
1 parent 8c748d6 commit c4da453

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/authentication/custom-strategies.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ keywords: authentication, config, configuration, overview, documentation, Conten
1010
This is an advanced feature, so only attempt this if you are an experienced
1111
developer. Otherwise, just let Payload's built-in authentication handle user
1212
auth for you.
13+
14+
**Development Note:** Changes to custom authentication strategies require a full server restart to take effect. Auth strategies are not hot-reloaded during development. Consider using tools like `nodemon` for auto-restart functionality.
1315
</Banner>
1416

1517
### Creating a strategy

0 commit comments

Comments
 (0)