[Documentation]: Add link for more details about block variations' example

[ntsekouras]

What?

In block variation docs the example is not documented properly. This PR adds a link with more info about it.

[Mamaduka]

LGTM 👍

[mcsf]

Would it be useful to copy the portion of the block.json schema concerning /example over to /variations/example?

Additionally, should we / how could we better surface our schemas in our docs?

[ntsekouras]

Would it be useful to copy the portion of the block.json schema concerning /example over to /variations/example?

I think it's not necessary, because it's the same block API and we would have to maintain the docs in two places. No strong opinions though..

Regarding the surfacing of schemas, I've no good thoughts right now :)

[mcsf]

Alternatively, we could use $ref:

diff --git a/schemas/json/block.json b/schemas/json/block.json
index 5b92a654fb..49aed81e97 100644
--- a/schemas/json/block.json
+++ b/schemas/json/block.json
@@ -706,8 +706,7 @@
 						"description": "Initial configuration of nested blocks."
 					},
 					"example": {
-						"type": "object",
-						"description": "Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type."
+						"$ref": "#/properties/example"
 					},
 					"scope": {
 						"type": "array",

Proof of concept:

json-schema-1.0.0.tgz — run w/ npm i && npm test — requires node@18