Improve Plugin Documentation
Opened this issue · 0 comments
RahiDroid commented
Description
The current readme file doesn't give enough information about the plugin. If somebody tries to use the plugin as is on their WordPress website, the on-boarding wouldn't be very smooth.
Consider below list for example questions that could be answered in the readme file,
- What's the purpose/need of the plugin?
- When should one consider using this plugin?
- Why should one consider using this plugin?
- How exactly does it improve the CWV scores?
- Are there any potential disadvantages of using this plugin? Will this function the same in all environments?
- Are there any things that one should be cautious about while using this plugin?
- Why does it use the worker thread? Explain how that change is better? Is it always better?
- What are all the custom hooks provided by this plugin?
- How do I whitelist a script? Does it whitelist any scripts by default? Does the plugin have any recommendations on whitelisting a certain scripts in case the plugin breaks my WordPress website?
Please note: These are just examples of things that could be part of the readme file, feel free to remove or add more items. Could also consider adding a FAQ section.