yaml-flow 7.0.0 → 8.0.0

package/examples/example-board/agent-instructions-cardlayout.md

@@ -1,56 +0,0 @@
-# Card Design Principles & Layout Guide
-
----
-
-## Card Design Principles
-
-- **Cards are not pages** — think post-it notes, not dashboards. The primary content (table, editable data) should be immediately visible, not buried below stacked metrics. Use at most one hero `metric`; collapse secondary summary figures into a single `text` line rather than multiple `metric` blocks.
-- **Single responsibility** — each card answers one question. If the title needs "and", split it.
-- **No redundancy across cards** — each column on a board should appear on exactly one card. If a value is already visible elsewhere, omit it; the user's eye can join cards mentally.
-- **Aggregations are distinct** — a metric that summarises data from another card (total, count, average) is not redundant — it is new information. Keep it.
-- **Separate input from output** — cards with editable elements (`editable-table`, `form`, `filter`) should stay lean; put heavy compute and display in a separate downstream card that `requires` the published token.
-- **Propagate data, not display** — use `provides` to pass data between cards; never duplicate a `source_defs[]` fetch for data another card already provides.
-- **KISS** — if you are unsure whether a field adds value, leave it out. A sparse card that is immediately readable is better than a dense card that requires study.
-
----
-
-## Layout
-
-```json
-"layout": {
-  "board":  { "col": 4, "order": 5 },
-  "canvas": { "x": 300, "y": 400, "w": 280, "h": 180 }
-}
-```
-
-- `board.col` — Bootstrap 12-column span: `3`=quarter, `4`=third, `6`=half, `8`=two-thirds, `12`=full
-- `board.order` — ascending integer, controls vertical sort in board view
-- `canvas` — pixel coordinates/size for drag-layout (canvas mode). `h` must be tall enough for all rendered content — a card with metrics + a 4-row table typically needs 400–500px. Too small a height causes an in-card scrollbar; when in doubt, size generously.
-
----
-
-## LLM View-Type Guidance (for `kind: "ref"`)
-
-When a source uses Copilot/LLM and the card renders via a `ref` element, the model should emit a `_view` hint alongside the data.
-
-- Keep `_view.kind` within the renderer whitelist only:
-  `table`, `editable-table`, `chart`, `metric`, `list`, `badge`, `text`, `narrative`, `markdown`, `form`, `filter`, `todo`, `alert`
-- Default to `table` when uncertain.
-- Use `editable-table` for user-adjustable tabular rows and include `data.writeTo` to a `card_data` path.
-- Use `chart` only when one clear category/value mapping exists; include `data.chartType` and `data.columns: [labelField, valueField]`.
-- Keep `_view.data` minimal. Static card JSON may override it for safety.
-
-Recommended response shape:
-
-```json
-{
-  "<data_key>": [ ... ],
-  "_view": {
-    "kind": "editable-table",
-    "data": {
-      "writeTo": "card_data.<key>",
-      "columns": ["field1", "field2"]
-    }
-  }
-}
-```