grafana / writers-toolkit

Technical documentation guidelines for Grafana Labs documentation
https://grafana.com/docs/writers-toolkit/
19 stars 13 forks source link

Add Vale rule to lint for writing specific shortcodes with percent syntax #700

Closed jdbaldry closed 1 month ago

jdbaldry commented 1 month ago

In most cases, it isn't needed. For consistency and pattern matching, we should prefer {{< because it better reflects the shortcode semantics we default to in our minds.

The other syntax is only necessary in specific contexts and the nuances are complicated.