@lunch-money/developer-docs 2.11.2-preview.1 → 2.11.2-preview.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/spec/AGENTS.md CHANGED
@@ -41,6 +41,12 @@ Follow these rules whenever editing `v2/spec/lunch-money-api-v2.yaml`:
41
41
  - Add links when they materially help consumers discover a related endpoint or relevant guide.
42
42
  - Do not add links that merely restate obvious navigation.
43
43
 
44
+ ### YAML formatting
45
+
46
+ - Write each description paragraph as a single line. Never hard-wrap prose to a column: inside a folded scalar a line break becomes a space, so a wrap landing beside punctuation or markup silently corrupts the rendered text.
47
+ - Use a folded block (`>-`) only when a description has more than one paragraph, separated by a blank line. A single-paragraph description stays on the key line.
48
+ - Never use a literal block (`|`, `|-`) for prose — newlines become significant, so reflowing later changes the output.
49
+
44
50
  ### Examples
45
51
 
46
52
  Examples are selective documentation aids, not a required artifact for every spec change.