Fix docs: Construct new TwoFactorAuth-class

[modelrailroader]

Hey,
your documentation to create a new object of the TwoFactorAuth class is wrong.
A single string like "sha1" is not enough; expected is an argument of Algorithm.

[willpower232]

This is an excellent observation however technically one doesn't need to specify the other arguments now the minimum supported version of PHP is greater than 8 so this example could be $tfa = new TwoFactorAuth(qrcodeprovider: $qrCodeProvider);

That said, the documentation about algorithm at docs/optional-configuration.md is definitely out of date.

[modelrailroader]

Sorry, I really forget this.
Do you think like this? I'm not so familiar with PHP 8 and all the changes yet...

[willpower232]

In this case it makes sense as I can imagine a significant number of users would just want to specify the name of the application and a QR code provider, unless one is developing for a specific hardware token or custom application then the default SHA1 should suffice which thanks to PHP 8 means you don't need to specify most of the constructor arguments.

Are you going to edit docs/optional-configuration.md as well?

[modelrailroader]

Done.

In this case it makes sense as I can imagine a significant number of users would just want to specify the name of the application and a QR code provider

But wouldn't it then not making more sense to change the position of the CodeProvider, so that the time when a code gets unvalid and the number of digits don't have to specified when defining the class?

Like this:
$tfa = new TwoFactorAuth(null, YourChosenProvider: $qrCodeProvider, 6, 30, Algorithm::Sha1);

@willpower232

[willpower232]

Unfortunately hindsight is 20:20 as they say, the construct method signature could have been made in a slightly more efficient way but that doesn't really matter any more thanks to newer PHP versions.

Also changing it would constitute a major breaking change for unsuspecting users so its better left as is for now.

Github won't let me suggest what the final wording should be but I think it should be this

[modelrailroader]

I have done this now, like you proposed.

Additionally, I fixed the hyperlinks for the documentation about the different online and offline providers. All hyperlinks had the file extension ".html", but it is ".md". ;-)

[modelrailroader]

You're right! Changed it.

[willpower232]

apologies for the delay! I wanted to do this at a time I could watch the build to make sure the docs website still works.