Skip to content
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

Documentation: clarify how to disable the generation of the /register route #536

Open
dogezen opened this issue Nov 15, 2024 · 0 comments
Open

Comments

@dogezen
Copy link

dogezen commented Nov 15, 2024

At the moment on the documentation for sign_in_route it isn't clear that you can omit the register_path option and that omitting it will ensure that /register path is not being generated.

Suggest amending the documentation paragraph to include a note about this:

`register_path` - the path under which to mount the password strategy's registration live-view. If not set, and registration is supported, registration will use a dynamic toggle and will not be routeable to. If a tuple {:unscoped, path} is provided, the registration path will not inherit the current route scope. If this option is omitted, then the `/register` route is not generated, in which case it is recommended to [override the sign in component](https://hexdocs.pm/ash_authentication_phoenix/ui-overrides.html#ashauthentication-phoenix-components-password) removing the register toggle text.

This could also link to the ash_authentication documentation on disabling registration: https://hexdocs.pm/ash_authentication/dsl-ashauthentication-strategy-password.html#authentication-strategies-password-registration_enabled?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant