Small readme improvements, remove the word "simple" #2671
Conversation
Most of us are reading the docs because we don't know how to do something, and it's not fun to hear that the concept we're having a hard time understanding is "simple" or "easy". I'd love you to show me how simple it is instead. A great reference: https://css-tricks.com/words-avoid-educational-writing/ Updated some language around `contenthash` as well, hopefully it's a little more direct. Let me know what you think.
src/content/guides/caching.md
Outdated
| @@ -24,7 +24,7 @@ This guide focuses on the configuration needed to ensure files produced by webpa | |||
|
|
|||
| ## Output Filenames | |||
|
|
|||
| A simple way to ensure the browser picks up changed files is by using `output.filename` [substitutions](/configuration/output#output-filename). The `[hash]` substitution can be used to include a build-specific hash in the filename, however it's even better to use the `[contenthash]` substitution which is the hash of the content of a file, which is different for each asset. | |||
| We can use the `output.filename` [substitutions](/configuration/output#output-filename) setting to define the names of our output files. Webpack provides a method of templating the filenames using bracketed strings called **substitutions**. The `[contenthash]` substitution will add a unique hash based on the content of an asset. When the asset's content changes, `[contenthash]` will change as well. | |||
There was a problem hiding this comment.
Switched this and another instance in the file.
|
Agree, nothing is simple or just, if you find more occurrences, please feel free to submit a PR changing them. |
|
Thanks! I have noticed other occurrences, but probably won't have time in the near future to edit. I did this page because I'm about to send some colleagues here 😄. |
src/content/guides/caching.md
Outdated
| @@ -24,7 +24,7 @@ This guide focuses on the configuration needed to ensure files produced by webpa | |||
|
|
|||
| ## Output Filenames | |||
|
|
|||
| A simple way to ensure the browser picks up changed files is by using `output.filename` [substitutions](/configuration/output#output-filename). The `[hash]` substitution can be used to include a build-specific hash in the filename, however it's even better to use the `[contenthash]` substitution which is the hash of the content of a file, which is different for each asset. | |||
| We can use the `output.filename` [substitutions](/configuration/output#output-filename) setting to define the names of our output files. webpack provides a method of templating the filenames using bracketed strings called **substitutions**. The `[contenthash]` substitution will add a unique hash based on the content of an asset. When the asset's content changes, `[contenthash]` will change as well. | |||
There was a problem hiding this comment.
We are using __ for boldness. Please use it here for consistency:
| We can use the `output.filename` [substitutions](/configuration/output#output-filename) setting to define the names of our output files. webpack provides a method of templating the filenames using bracketed strings called **substitutions**. The `[contenthash]` substitution will add a unique hash based on the content of an asset. When the asset's content changes, `[contenthash]` will change as well. | |
| We can use the `output.filename` [substitutions](/configuration/output#output-filename) setting to define the names of our output files. webpack provides a method of templating the filenames using bracketed strings called __substitutions__. The `[contenthash]` substitution will add a unique hash based on the content of an asset. When the asset's content changes, `[contenthash]` will change as well. |
Doesnt markdown lint throw for you when you lint it?
|
yeap lint fails, make sure that lint passes before you push |
|
Will do, thanks for the tips. I did this all in the gh editor, didn’t think
about lints or scripts.
|
|
If you have difficulties @robwierzbowski please let me know |
|
Formatting updates made. |
|
Please fix this error:
|
Weasel word, and the statement doesn't really give value.
|
Proselint isn't installed locally -- you might want to install that as a dev dependency so users don't have to install globally. I would install but proselint triggers npm vulnerability warnings, don't know how you want to handle that. I'm also getting Update to remove However. Let me know if you'd like me to do anything else! |
|
Thanks! |
Most of us are reading the docs because we don't know how to do something, and it's not fun to hear that the concept we're having a hard time understanding is "simple" or "easy". I'd love you to show me how simple it is instead.
A great reference: https://css-tricks.com/words-avoid-educational-writing/
Updated some language around
contenthashas well, hopefully it's a little more direct. Let me know what you think.