Convert Brew "Front Matter" to a single encoded yaml block

[dbolack-ab]

This might be a little bit of overkill.

One of the challenges I have had working with the different PRs that extended the Brew document was effectively breaking live documents when adding a new "codeblocked" frontmatter section. The current unpacking method expects code blocks in a particular order.

I propose changing this to a YAML or JSON stored document wrapped in a new codeblock, such as ```brewdata```

This should allow us to pack new sections into a stored document that won't cause issues if missing or "out of order"

[calculuschild]

For clarity, you are proposing changing this:

```metadata
title: xyz
description: xyz
etc: etc
```

```css
some css
```

The brew content

to

```brewdata
metadata:
  title: xyz
  description: xyz
  etc: etc

css: some css
```

The brew content

Is that correct? The metadata block is already in YAML format.

If yes, I would be OK with this (just moving "CSS" into a new field alongside the metadata YAML). But I'm not exactly sure how we would retroactively apply this change to existing documents.

It might be possible to leave the existing structure in place, and start adding any new fields to the metadata block. So the snippets for example could go there instead of in a new ```snippets block. Then we only ever have two codeblocks to deal with.

[G-Ambatte]

The current unpacking method expects code blocks in a particular order.

Alternatively, would a simpler solution be to modify the existing unpacking method to handle the metadata blocks correctly, regardless of order? To my mind, this would not require any change of existing documents, and still resolve the original issue.

[calculuschild]

Yes, we can update the unpacking method as well.

But as a separate action, I think there is merit deciding on a future policy that we will not be adding any new metadata blocks from now on. Just fit any new fields (e.g. custom snippets) into the existing metadata block and leave the CSS block where it is.

[G-Ambatte]

That makes sense to me: snippets are a part of the brew's metadata, and thus should go in the metadata block. I don't currently see a reason that they would need to be in their own block.

[dbolack-ab]

The current unpacking method expects code blocks in a particular order.

Alternatively, would a simpler solution be to modify the existing unpacking method to handle the metadata blocks correctly, regardless of order? To my mind, this would not require any change of existing documents, and still resolve the original issue.

I thought about this as well, but felt like the best solution was one that moved all of the document "metadata and support structures" into a single extractable section.

I can see the argument for not moving CSS/not moving CSS right now.

[dbolack-ab]

Closing due to consensus