factory-muffin icon indicating copy to clipboard operation
factory-muffin copied to clipboard

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

Open ctrlaltdylan opened this issue 8 years ago • 8 comments

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.

ctrlaltdylan avatar Oct 31 '17 14:10 ctrlaltdylan

Duplicate of #362

igneus avatar Mar 23 '18 10:03 igneus

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.

GrahamCampbell avatar Jun 17 '20 00:06 GrahamCampbell

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.

igorsantos07 avatar Jun 17 '20 00:06 igorsantos07

The website is open source, and open to PRs.

GrahamCampbell avatar Jun 17 '20 09:06 GrahamCampbell

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.

igorsantos07 avatar Jun 22 '20 03:06 igorsantos07

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

GrahamCampbell avatar Jun 22 '20 09:06 GrahamCampbell

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 [email protected] 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 .

igorsantos07 avatar Jun 24 '20 06:06 igorsantos07

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

GrahamCampbell avatar Jun 24 '20 07:06 GrahamCampbell