Fix our documentation until we release Reek 5.

[troessner]

Fixes #1327

[mvz]

Oh man I'm torn about this.

I was going to say if we're going for the solution where we have to change the README just before the release we can just put a pointer to the v4.8.1 README, so documentation an code actually match for the given repo state.

However, this PR also solves the problem that all our -U links link to the master branch. The really terrible thing is that even after we release 5.0 there will be people using 4.x and getting broken links.

[troessner]

However, this PR also solves the problem that all our -U links link to the master branch. The really terrible thing is that even after we release 5.0 there will be people using 4.x and getting broken links.

Oh yeah, boy, we really did NOT think this whole thing through, now did we 😆

I'm all up for fixing #1330 asap but what do you think about merging this PR first and independently of that so that at least the majority of our docs are sane again?

[mvz]

Ok, how about:

• Putting just a notice in the README saying 'This is the README for master, please look here for the currently released version'
• Putting back the PrimaDonnaMethod documentation, ideally with a notice that it will be renamed in 5.0.
• Leaving the rest as-is so we don't get confused.

I agree that #1330 is something we can fix after we stopped the current confusion.

[troessner]

Putting back the PrimaDonnaMethod documentation, ideally with a notice that it will be renamed in 5.0.

Just did that.

Putting just a notice in the README saying 'This is the README for master, please look here for the currently released version'

Unless we make that "marquee" and "h1" i doubt people are reading that, especially if you quickly want to look something up (what most of our users are doing i suppose) you won't catch that.

[mvz]

This can stay as it is I think.

[troessner]

While it's true that we're not checking for the file extension explicitly when specifying a config file I still think it's very confusing that all of a sudden we have a configuration file with a yaml extension.

[mvz]

Oh wait I missed that this was also in the docs. Please ignore my remark for this line.

[mvz]

Unless we make that "marquee" and "h1" i doubt people are reading that, especially if you quickly want to look something up (what most of our users are doing i suppose) you won't catch that.

I like to think I always notice, but there's no way of knowing, is there? Anyway, let's just merge this so we can think of the Awesomest Best Solution for Pointing People to the Right Documentation (ABSPPRD) at leisure.

[troessner]

And merged it is ;)