docs(website): fill the six Reference stubs with worked examples + output
Expand columns, relationships, indexes, constraints, inserting-and-editing- data, and querying-and-inspecting from syntax-only stubs into full pages, each with worked examples on the library schema and real captured app output (structure boxes, relationship diagrams, data tables, show-lists, query plans, cascade summaries). All output captured verbatim from the app — never hand-drawn. Both simple- and advanced-mode forms shown where both apply; advanced syntax verified against tests/source. STYLE.md: record the output-block convention (plain unlabelled fence, captured from a throwaway harness, not hand-drawn). Verified: pnpm build clean (24 pages); no forbidden terms; internal links and heading anchors resolve.
This commit is contained in:
@@ -104,6 +104,17 @@ This is planned and not yet available.
|
||||
- **One command per line** in an `rdbms` block; a multi-line single
|
||||
statement (e.g. advanced `CREATE TABLE`) belongs in a ` ```sql ` block,
|
||||
where no prompt is added.
|
||||
- **Command output → a plain unlabelled ` ``` ` fence** placed immediately
|
||||
after the command block (no language, so no `> ` prompt and no
|
||||
highlighting). Output must be **captured from the real app**, never
|
||||
hand-drawn — box-drawing diagrams, query-plan trees, and data tables are
|
||||
copied verbatim (trailing padding spaces trimmed). The capture method: a
|
||||
throwaway in-crate test that builds the canonical library schema and prints
|
||||
the rendered output (`render_structure_with_diagrams`,
|
||||
`render_relationship_diagram`, `render_data_table`, `render_explain_plan`,
|
||||
`show_list`), removed once the output is pasted. Colour is lost in a static
|
||||
block (the structure still reads); the coloured/animated rendering is
|
||||
earmarked for casts.
|
||||
|
||||
### Canonical library schema (source of truth for examples)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user