litespeedtech / litespeedtech/lscache_wp
Please update your documentation so it's current
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 257
- Forks
- 123
- PR merge metrics
- No merged PRs in 30d
Description
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/]](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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked LiteSpeed Cache documentation page and compare its `LSCWP_CTRL=before_optm` troubleshooting instruction and screenshots with the current production plugin. Review the rest of that page for similar version mismatches. Done means the guidance and screenshots match the current plugin, or obsolete material is removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php, wordpress
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100