Add information about the more HTML comment

[jtvdez]

Adds an entry in shortcodes for <!--more--> and information on when to use it in the section over contributing to what's new.

[github-actions]

Readability report

File	AutomatedReadability	ColemanLiau	FleschKincaid	FleschReadingEase	GunningFog	LIX	SMOG
docs/sources/contribute/release-notes/index.md	$${8.20\space\color{green}(Δ-0.03)}$$	$${9.58\space\color{green}(Δ-0.02)}$$	$${8.66\space\color{green}(Δ-0.02)}$$	$${60.65\space\color{green}(Δ+0.06)}$$	$${10.46\space\color{green}(Δ-0.01)}$$	$${37.82\space\color{green}(Δ-0.08)}$$	$${11.26\space\color{green}(Δ-0.02)}$$

View metric targets

Metric	Range	Ideal score
AutomatedReadability	6 (very easy read) to 14 (extremely difficult read)	8 or less
ColemanLiau	6 (very easy read) to 17 (extremely difficult read)	9 or less
FleschKincaid	6 (very easy read) to 17 (extremely difficult read)	8 or less
FleschReadingEase	100 (very easy read) to 0 (extremely difficult read)	70 or more
GunningFog	6 (very easy read) to 17 (extremely difficult read)	10 or less
LIX	20 (very easy read) to 60+ (extremely difficult read)	35 or less
SMOG	6 (very easy read) to 17 (extremely difficult read)	10 or less

[github-actions]

💻 Deploy preview available (Add information about the more shortcode):

• https://deploy-preview-writers-toolkit-1242-zb444pucvq-vp.a.run.app/docs/writers-toolkit/

[jtvdez]

@jdbaldry using <!--more--> in it's description breaks the preview I get from make docs locally somewhat (getting rid of the backticks around the first instance of it actually leaves the rest of the note fairly intact but then there's a weird line break and you can't see the initial instance at all. Any suggestions? 😄 also I doubt we'd consider this properly a shortcode, more of a tag really, but this seemed like the best place to tell people that we can use it in what's new posts? Happy to make adjustments as needed, could even be contained wholly within the contributing to what's new section, but I didn't wanna go off the rails with explanation there if it can be avoided

[jtvdez]

So in response to my initial comment:

I've removed the description from shortcodes entirely and am focusing on a succinct description as a step in the contributing to what's new section (see latest commit). But the initial thing I mentioned is still happening. Leaving it as is right now until somebody can have a look but worth mentioning that it still behaves this way whether i use backticks or try to put it in a codeblock

[jdbaldry]

Leaving it as is right now until somebody can have a look but worth mentioning that it still behaves this way whether i use backticks or try to put it in a codeblock

Yeah, the HTML rendering strips HTML comments out so we have to indirect them in some way. In this case, I used a front matter lookup with the param shortcode.

[github-actions]

💻 Deploy preview available (Add information about the more HTML comment):

• https://deploy-preview-writers-toolkit-1242-zb444pucvq-vp.a.run.app/docs/writers-toolkit/