NekR / offline-plugin

Offline plugin (ServiceWorker, AppCache) for webpack (https://webpack.js.org/)
MIT License
4.52k stars 294 forks source link

Ideas for Documentation to Help with Troubleshooting #483

Closed sheparddw closed 4 years ago

sheparddw commented 4 years ago

Hey, I appreciate this repo. Works great! It took me some time to troubleshoot why this was not working for my project though when I was setting it up.

First, I forgot to re-enable browser cache in Dev Tools (which is obvious, but maybe mention this on Troubleshooting to remind people).

Second, it took me hours to figure out why the assets were cached in Cache Storage but not used by my app. It turned out the appShell parameter needed to be set even though the publicPath used the webpack defaults. Maybe a bit more explaination on the appShell option under the options or troubleshooting doc on this needing to be set if the assets are cached but not used might help others avoid my hours of troubleshooting?

Figured I would mention these issues I faced to help others and perhaps suggest a bit of changes to the documentation when you or someone else has a chance. :)