thephpleague / factory-muffin

Enables the rapid creation of objects for testing
https://factory-muffin.thephpleague.com/
MIT License
532 stars 72 forks source link

Update documentation on the league website to match the README on the ~3.0 branch #448

Open ctrlaltdylan opened 6 years ago

ctrlaltdylan commented 6 years ago

Not sure the existing deployment method from markdown to html on the league website, but the current site on the league website is showing documentation for v2. This is pretty confusing because it heavily relies on a Facade class that I think is no longer in use in v3.

igneus commented 6 years ago

Duplicate of #362

GrahamCampbell commented 4 years ago

Duplicate of #362

No it's not. #362 is specifically about the upgrading guide not having as much detail for the last release as was the case with previous major releases.

igorsantos07 commented 4 years ago

Got fooled by that comment... But yeah, 4~5 years of a release without updated docs is pretty lame IMHO. The entire website is outdated, so until this is solved by either maintainers or a PR, I would suggest making it redirect to the README instead.

GrahamCampbell commented 4 years ago

The website is open source, and open to PRs.

igorsantos07 commented 4 years ago

Yeah, for 3 years. If you're not going to fix your own release, and I don't have the time to give you that (otherwise I would have already, you've already suggested that I should), just redirect it. Stop fooling others into the same trap.

GrahamCampbell commented 4 years ago

Hardly a trap. v2 still exists, and you can use it exactly how the website says. It even tells you how to install it.

igorsantos07 commented 4 years ago

So the suggestion is to use an old (unmaintained?) version just because that's the one with documentation up to date, even if the next version was released 5 years ago?

Seriously, what's wrong with getting the website down instead of leaving it outdated forever there? If you're not going to update it, remove. README is enough and we're used to reading long README files, just don't leave misleading stuff on the web.

On Mon, Jun 22, 2020 at 6:28 AM Graham Campbell notifications@github.com wrote:

Hardly a trap. v2 still exists, and you can use it exactly how the website says. It even tells you how to install it.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/thephpleague/factory-muffin/issues/448#issuecomment-647399209, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAEB6S4MV52MB2FJ4BIWVYTRX4P33ANCNFSM4EBTHEZA .

GrahamCampbell commented 4 years ago

I suppose I could also test version 2.1.x against PHP 7. It should work just fine.