Before You File a Documentation Request Please Confirm You Have Done The Following...

• I have looked for existingopen or closed documentation requests that match my proposal.
• I haveread the FAQ and my problem is not listed.

Suggested Changes

We've had a number of docs issues where the errors reported on an example block were not correct. The big reason this occurs is a few reasons:

1. we don't validate the examples at all
2. it's really hard for a reviewer to visualise the errors (open pr, click netlify preview link, navigate to docs, pick example, click open in playground, preview errors - PHEW that's a lot of steps)
3. we have no way to visualise changes to the errors over time - so changes to rule behaviour that may remove or add errors aren't tracked.

For each rule doc code block we should render a snapshot output for each of its code samples which is the result of running the rule+config on the snapshot.
We could even make this a test which enforces that "valid" examples have no errors.

This would go hand-in-hand with#8381 to allow us to pre-visualise the shiki output and would be a natural partner to#6994.

Affected URL(s)

docs/rules/*