search

litespeedtech / lscache_wp

LiteSpeed Cache for WordPress
http://wordpress.org/plugins/litespeed-cache/
GNU General Public License v3.0
212 stars 108 forks source link

Please update your documentation so it's current #631

Open kupietools opened 6 months ago

kupietools commented 6 months ago

It's very frustrating to try to troubleshoot an issue with obsolete documentation. For instance, your page at [https://docs.litespeedtech.com/lscache/lscwp/ts-optimize/] says to use /?LSCWP_CTRL=before_optm at the end of an url to disable lightspeed. This does not disable lightspeed.

This is not the only time I've noticed things in your documentation that do not match the actual production version of your plugin, it's just the one that's tripping me up today. It really wastes a lot of time to be chasing down ghosts like this. I have a frustrating sporadic problem with some javascript, and to additionally have to troubleshoot your documentation on top of troubleshooting the javascript is really making things unnecessarily difficult. Right now I have no idea how to troubleshoot this problem because the documention says to do things that no longer work.

That page also shows screenshots of the plugin that are not the same as what appears in the plugin. Obviously this is the documentation for an obsolete version of the plugin.

It would be better to have no documentation at all than to have incorrect documentation. Please try to keep things up to date, or if you can't, please take the documentation down completely and let people just file issues instead, so long as they're not being misled. Thanks.

lslisa commented 6 months ago

Hi, @kupietools . I'm in charge of our documentation and I appreciate the constructive feedback.

your page says to use /?LSCWP_CTRL=before_optm at the end of an url to disable lightspeed. This does not disable lightspeed.

Actually, what it says is that it disables the optimization features of LiteSpeed, and that is exactly what it does. We only mention optimization on that page, because the CSS and JS optimizations are what you are troubleshooting. There are other ways to disable certain features, though, and they are mentioned in the general troubleshooting doc:

Right now I have no idea how to troubleshoot this problem because the documention says to do things that no longer work.

If you have any specific examples, please share and I will fix them.

That page also shows screenshots of the plugin that are not the same as what appears in the plugin.

I'll check those and make any necessary updates this week.

Thanks again for your feedback.

lslisa commented 6 months ago

Hi again, @kupietools . Just wanted to let you know I've cleaned up the screenshots in all of the LSCWP Troubleshooting docs. If you have any other specific issues to report, please let me know.