add documentation for remove emoji #216
Conversation
![hm-linter[bot]](https://avatars.githubusercontent.com/in/5455?s=60&v=4){kind=small}
|
I'm kind of in 2 minds here. In the original issue I think I chose a bad name for the config option. Talking about removing emoji is a bit confusing and drastic sounding as we're really just removing the image replacement functionality. We'd need to be very clear about that in the wording throughout. Do you think the general explanation of what emoji are and the details about the specific JS files that are no longer loaded might be more than is really needed? I think it just needs to explain that if your website might be run on systems that do not support emoji you can enable image replacements by setting this setting. In a similar pattern to the search and SEO module docs maybe we could condense this into a small section on the main readme if there isn't enough to warrant a full page. I might make an issue for renaming that config option first (we can keep back compat) but I think it'll help with making these docs clearer. |
|
@roborourke I think renaming the config option is a better first step. As you say, "remove emoji" sounds pretty drastic and misleading, and the description, I think, makes less sense if you go into it with that frame of reference. As such, we should punt this to 6.0 and make changing the option name a dependency of this. |
| @@ -0,0 +1,27 @@ | |||
| # Remove Emoji Image Replacement | |||
|
|
|||
| Remove all the emoji scripts that are included with WordPress. By default, this module is active. To allow emojis, toggle the `remove-emoji` module in the Altis config. | |||
There was a problem hiding this comment.
"To allow emojis" should be "To allow emoji image replacement"
|
Created #260 for the setting name change |
See #96