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

Add documentation about how to override the passkeys_authenticatable for Devise.add_module #17

Open
tcannonfodder opened this issue Jun 23, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tcannonfodder
Copy link
Contributor

Previously in #13; I thought the module was not being defined inside the gem, but it's actually defined in: https://github.com/ruby-passkeys/devise-passkeys/blob/main/lib/devise/passkeys.rb#L26

Instead, the template repo overrides the module definition with its implementation-specific definitions, which is what we actually want to happen here; since each app will have to create its own set of controllers.

We should update the README to include documentation about how the step is needed (and why!); and use the code from the template repo as example code

@tcannonfodder tcannonfodder added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 23, 2023
@tcannonfodder tcannonfodder added this to the YARD Documentation milestone Jun 23, 2023
@tcannonfodder tcannonfodder added the help wanted Extra attention is needed label Jun 23, 2023
@johalloran01
Copy link
Contributor

johalloran01 commented Jul 6, 2023

Located in passkeys.rb line 48.
Template repo: https://github.com/ruby-passkeys/devise-passkeys-template/blob/main/app/models/user.rb

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants