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

more useful documentation please. #470

Closed
epipheus opened this issue Feb 5, 2025 · 2 comments
Closed

more useful documentation please. #470

epipheus opened this issue Feb 5, 2025 · 2 comments

Comments

@epipheus
Copy link

epipheus commented Feb 5, 2025

Don't take this the wrong way. I have only recently discovered rodauth and only because I have a crazy weird Devise bug that had grounded me, to the point I am starting auth over to make sure I'm done with the bug. I want Rodauth to be the amazing saviour is claims to be. My biggest issue is that the "documentation" isn't really documentation. It's a feature list. It doesn't help me get up to speed at all. The readme may well be the worst part.

What's the difference between Rodauthapp and Rodauthmain, like why, what's happening? OK there a Sequel thing, what does it really mean for us practically? Is that really the first thing we need to understand? So many of us are oppressed by Devise and need Rodauth. Please. How can we help you get this all documented so we can be free of Devise.

Like How does this work with strong parameters? Devise can be used to have all kinds of user resource types. Can I accomplish the same? Can only have one or can we have multiple named resources that can all log in to the same system. Ok you chose Account over User and attach user-like things to it like email to it, then attach some things to profiles but in your default case you don't have a user model. i guess that's ok. But we need succint docs on it. Most of us are coming from devise and can see some similarity, help us navigate to the awesome parts knowing that most of us are use to User model being the center and Account being nomenclature related to tenancy concerns and not for every user. I mean; cool you came up with what seems to legitimately be the most advanced auth system for ruby and none of it matters if we can't use it. The docs seem more like a list of features and not succinct instructionsthat help us get up to speed quickly. You do a lot of things differently but don't spent enough time showing the on ramps for getting into this difference. the janko videos are a good start, perhaps even a better first step but the readme should be. but i feel like we'd be better off if you helped us to use your amazing thing you've made. there is no reason this cant be the default. No way we should wait multiple cycles for breaking changes to get fixed on Devise (turbo or no turbo). easy crypto or no most of us don't want to roll our own auth you should be the #1 choice here.

@jeremyevans
Copy link
Owner

Your question appears to be specific to rodauth-rails, not Rodauth itself (your mention of RodauthApp and RodauthMain, Devise, and strong parameters), so you probably want to open a discussion (not an issue, this isn't a bug) in rodauth-rails: https://github.com/janko/rodauth-rails/discussions/new/choose

@janko
Copy link
Contributor

janko commented Feb 6, 2025

I find this kind of feedback valuable, so I also encourage you to open a discussion in rodauth-rails. I assume you were referring to rodauth-rails' readme, while for "documentation" you were talking about the website?

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

3 participants