[ Fix ]: Docs suggest "failureRedirect" as optional but throws Error when removed.

[justin-hackin]

In the example here it is stated:

// The failureRedirect route will be used to render any possible error. // If not provided, ErrorBoundary will be rendered instead.

When it is removed from the options, we get Error: Missing required failureRedirect URL. in a case that would normally succeed. I assumed what this comment meant is that failures will just throw instead of redirecting. Was that the intent?

[dev-xo]

Good catch @justin-hackin, if you want to contribute to fixing that comment, it will be more than welcome. Otherwise, I will look into it whenever I get a moment.

Thank you for the catch!

[justin-hackin]

Good catch @justin-hackin, if you want to contribute to fixing that comment, it will be more than welcome. Otherwise, I will look into it whenever I get a moment.

Thank you for the catch!

Hi, thanks for the invite. I'm pretty confused about how this library works (e.g. why is authenticate called on both login and verify in the example and what's going on under the hood). I don't think I'll be able to contribute.

[chiptus]

@dev-xo do you expect the docs to be fixed? or the actual code?

[dev-xo]

I think the issue is about the docs not matching the actual code behavior, at least it's what I'm able to understand. The fix should be simple (docs related), sadly I'm kinda busy, although I can look into it anytime soon.

Not sure if that's your question @chiptus, would appreciate some specification on it.

[chiptus]

as you said docs are not matching the code. should the docs be fixed? or the code to match the docs?

[dev-xo]

Code should be working as expected, so in this case, probably the docs should be fixed. Not sure if you want to contribute with a little PR, but if that's the case, it will be welcomed! ;)

• We went through a few major updates, and probably there are a few bits of documentation code that we could have missed to either adapt or update. This seems to be the case in this one.

failureRedirect should be required, and seems to be specified as optional in those comments. At least in the example provided by @justin-hackin, related to one of our starter templates.

• Wonder if that's also specified like that in our docs or in some other places. Could be.

[dev-xo]

• https://github.com/dev-xo/remix-auth-totp/commit/771d7ef961751f6dffa07fd146c60640a553b7b5
• https://github.com/dev-xo/totp-starter-example/commit/b23f1639c8e992ea5be64da92d4b40028824ce24
• https://github.com/dev-xo/totp-flat-routes-example/commit/b2d406c28c59b0a3f913a5c2c3a65c3ef1c591f8
• https://github.com/dev-xo/totp-conform-example/commit/09b11f1637f727d0248bc1e6c00f48fb25141c42

Thanks for noticing this, @justin-hackin. If there's anything else, let me know 👍🏻