-
Notifications
You must be signed in to change notification settings - Fork 904
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document cache invalidation opportunity #1377
base: master
Are you sure you want to change the base?
Conversation
@@ -40,3 +40,11 @@ Files with the `scss` extension use "Sassy CSS" syntax, | |||
while files with the `sass` extension use the "indented" syntax: <https://sass-lang.com/documentation/syntax>. | |||
Zola will return an error if `scss` and `sass` files with the same | |||
base name exist in the same folder to avoid confusion -- see the example above. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part of the docs is about the content itself, not the templates. None of the other pages in that section mention template specific things like functions.
I agree it would be useful to show this kind of section somewhere but I don't know where. @southerntofu any ideas?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should probably go here with the get_url
docs no? (by the way having built-ins in theme overview has always confused me i'd rather have a "FIlters/Functions" pages)
Also maybe explain what cachebust
does (checksumming) by providing an example output HTML?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
by the way having built-ins in theme overview has always confused me i'd rather have a "FIlters/Functions" pages
Yeah... this was made when there was one function, it should be split.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We now have 3 filters and 10 functions.
Maybe it would make sense to have two separate pages — one for filters and one for functions? I see a few advantages to having separate pages:
- Users may more quickly understand the difference between filters and functions.
- Shorter pages means less scrolling to get to the thing you are looking for.
- If we use one page now and add more content, we might want to split the pages later. In that case, we may break links to the documentation. Using two pages right away is more future-proof.
On the other hand, it would mean a bigger menu. I see that as less of a concern than the ones outlined above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put them all in the same page though, at least for now
It took me a while to discover
cachebust
, so it might be useful to others to have it in the Sass docs.Sanity check: