Problem/Motivation
I found some issues with the documentation. I spent a good deal of time trying to figure out why there were no filename suggestions in the Twig debug. I also mistakenly thought some headings were subordinate to another heading based on their heading levels.
Proposed resolution
Add to the documentation where it says “When twig debug is enabled, Critical CSS will show all the possible file paths that is trying to find inside a css comment.” Add something like, “If you see ‘NONE MATCHED’, check to see if you are logged in and make sure Critical CSS is enabled for logged-in users. Since the contents of the critical CSS files are generated emulating an anonymous visit, I recommend disabling this feature once you’ve finished testing.”
For headings, “Third party libraries”, “Module configuration”, and “Debugging” should probably be `h2` instead of `h3` as they are not subordinate to “Gulp task for generating a critical css file”
I think these changes to the documentation will make it easier for people trying to get this module up and running more quickly.
Comments
Comment #3
albertosilvaThanks @revoltpuppy,
You are right, if you are logged it could be tricky to understand what is happening. I have fixed the issues with the documentation and rearranged the headings so debugging is now one of the first ones.
Comment #4
albertosilvaComment #5
albertosilva