Follow a certain order when listing blocks and arguments in documentation

[ptodev]

Background

The document on best practices with writing Flow components should also include guidance on how to order blocks and attributes when listing them in a table. This will help make our documentation more predictable and easier to read.

Proposal

For example, we could propose that:

• required attributes/blocks should be listed prior to any optional ones.
• sections about blocks should appear in the same order in which the blocks were listed in the table. E.g. if an annotations block is listed before a filter block in the table, then the ### annotations block section should also appear before the ### filter block section.

It would also be nice if we could also add CI tests for this. But I'm not sure if this is possible.

[tpaschalis]

I'm on-board with the two suggestions here. Also, maybe we should talk about the specific order within required and optional. Is it alphabetical order, is it up to the component author's discretion to order by usefuleness/frequency of use?

[clayton-cornell]

Some drafting (testing ideas and changes) happening in this PR: https://github.com/grafana/alloy/pull/1630