tinybase 8.2.0-beta.1 → 8.2.0-beta.2

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.
@@ -690,7 +690,10 @@ export type SortedTablePaginatorProps = {
690
690
  * Store as an HTML <table> element, and registers a listener so that any
691
691
  * changes to that result will cause a re-render.
692
692
  *
693
- * See the <TableInHtmlTable /> (React) demo for this component in action.
693
+ * See the <TableInHtmlTable /> (React) demo for this component in action:
694
+ *
695
+ * ![TableInHtmlTable example](/shots/tableinhtmltable-react-demo.png
696
+ * "TableInHtmlTable example")
694
697
  *
695
698
  * The component's props identify which Table to render based on Table Id, and
696
699
  * Store (which is either the default context Store, a named context Store, or
@@ -833,7 +836,11 @@ export function TableInHtmlTable(
833
836
  * that any changes to that result will cause a re-render.
834
837
  *
835
838
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
836
- * action.
839
+ * action:
840
+ *
841
+ * ![SortedTableInHtmlTable example](
842
+ * /shots/sortedtableinhtmltable-react-demo.png
843
+ * "SortedTableInHtmlTable example")
837
844
  *
838
845
  * The component's props identify which Table to render based on Table Id, and
839
846
  * Store (which is either the default context Store, a named context Store, or
@@ -1003,7 +1010,10 @@ export function SortedTableInHtmlTable(
1003
1010
  * as an HTML <table> element, and registers a listener so that any changes to
1004
1011
  * that result will cause a re-render.
1005
1012
  *
1006
- * See the <ValuesInHtmlTable /> (React) demo for this component in action.
1013
+ * See the <ValuesInHtmlTable /> (React) demo for this component in action:
1014
+ *
1015
+ * ![ValuesInHtmlTable example](/shots/valuesinhtmltable-react-demo.png
1016
+ * "ValuesInHtmlTable example")
1007
1017
  *
1008
1018
  * The component's props identify which Row to render based on Table Id, Row Id,
1009
1019
  * and Store (which is either the default context Store, a named context Store,
@@ -1131,7 +1141,10 @@ export function ValuesInHtmlTable(
1131
1141
  * <table> element, and registers a listener so that any changes to that result
1132
1142
  * will cause a re-render.
1133
1143
  *
1134
- * See the <SliceInHtmlTable /> (React) demo for this component in action.
1144
+ * See the <SliceInHtmlTable /> (React) demo for this component in action:
1145
+ *
1146
+ * ![SliceInHtmlTable example](/shots/sliceinhtmltable-react-demo.png
1147
+ * "SliceInHtmlTable example")
1135
1148
  *
1136
1149
  * The component's props identify which Slice to render based on Index Id, Slice
1137
1150
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1286,7 +1299,11 @@ export function SliceInHtmlTable(
1286
1299
  * so that any changes to that result will cause a re-render.
1287
1300
  *
1288
1301
  * See the <RelationshipInHtmlTable /> (React) demo for this component in
1289
- * action.
1302
+ * action:
1303
+ *
1304
+ * ![RelationshipInHtmlTable example](
1305
+ * /shots/relationshipinhtmltable-react-demo.png
1306
+ * "RelationshipInHtmlTable example")
1290
1307
  *
1291
1308
  * The component's props identify which Relationship to render based on
1292
1309
  * Relationship Id and Relationships object (which is either the default context
@@ -1461,7 +1478,11 @@ export function RelationshipInHtmlTable(
1461
1478
  * listener so that any changes to that result will cause a re-render.
1462
1479
  *
1463
1480
  * See the <ResultTableInHtmlTable /> (React) demo for this component in
1464
- * action.
1481
+ * action:
1482
+ *
1483
+ * ![ResultTableInHtmlTable example](
1484
+ * /shots/resulttableinhtmltable-react-demo.png
1485
+ * "ResultTableInHtmlTable example")
1465
1486
  *
1466
1487
  * The component's props identify which ResultTable to render based on query Id,
1467
1488
  * and Queries object (which is either the default context Queries object, a
@@ -1611,7 +1632,11 @@ export function ResultTableInHtmlTable(
1611
1632
  * re-render.
1612
1633
  *
1613
1634
  * See the <ResultSortedTableInHtmlTable /> (React) demo for this component in
1614
- * action.
1635
+ * action:
1636
+ *
1637
+ * ![ResultSortedTableInHtmlTable example](
1638
+ * /shots/resultsortedtableinhtmltable-react-demo.png
1639
+ * "ResultSortedTableInHtmlTable example")
1615
1640
  *
1616
1641
  * The component's props identify which ResultTable to render based on query Id,
1617
1642
  * and Queries object (which is either the default context Queries object, a
@@ -1782,7 +1807,10 @@ export function ResultSortedTableInHtmlTable(
1782
1807
  * that can be edited in a web browser, and registers a listener so that any
1783
1808
  * changes to that result will cause a re-render.
1784
1809
  *
1785
- * See the <EditableCellView /> (React) demo for this component in action.
1810
+ * See the <EditableCellView /> (React) demo for this component in action:
1811
+ *
1812
+ * ![EditableCellView example](/shots/editablecellview-react-demo.png
1813
+ * "EditableCellView example")
1786
1814
  *
1787
1815
  * The component's props identify which Cell to render based on Table Id, Row
1788
1816
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1850,7 +1878,10 @@ export function EditableCellView(
1850
1878
  * that can be edited in a web browser, and registers a listener so that any
1851
1879
  * changes to that result will cause a re-render.
1852
1880
  *
1853
- * See the <EditableValueView /> (React) demo for this component in action.
1881
+ * See the <EditableValueView /> (React) demo for this component in action:
1882
+ *
1883
+ * ![EditableValueView example](/shots/editablevalueview-react-demo.png
1884
+ * "EditableValueView example")
1854
1885
  *
1855
1886
  * The component's props identify which Value to render based on Table Id, Row
1856
1887
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -1918,7 +1949,10 @@ export function EditableValueView(
1918
1949
  * The SortedTablePaginator component renders a paginator for a sorted table.
1919
1950
  *
1920
1951
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
1921
- * action.
1952
+ * action:
1953
+ *
1954
+ * ![SortedTablePaginator example](/shots/sortedtablepaginator-react-demo.png
1955
+ * "SortedTablePaginator example")
1922
1956
  *
1923
1957
  * The component displays 'previous' and 'next' buttons for paging through the
1924
1958
  * Table if there are more Row Ids than fit in each page. The component will
@@ -672,7 +672,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
672
672
  * ): ComponentReturnType;
673
673
  * ```
674
674
  *
675
- * See the <TableInHtmlTable /> (React) demo for this component in action.
675
+ * See the <TableInHtmlTable /> (React) demo for this component in action:
676
+ *
677
+ * ![TableInHtmlTable example](/shots/tableinhtmltable-react-demo.png
678
+ * "TableInHtmlTable example")
676
679
  *
677
680
  * The component's props identify which Table to render based on Table Id, and
678
681
  * Store (which is either the default context Store, a named context Store, or
@@ -823,7 +826,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
823
826
  * ```
824
827
  *
825
828
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
826
- * action.
829
+ * action:
830
+ *
831
+ * ![SortedTableInHtmlTable example](
832
+ * /shots/sortedtableinhtmltable-react-demo.png
833
+ * "SortedTableInHtmlTable example")
827
834
  *
828
835
  * The component's props identify which Table to render based on Table Id, and
829
836
  * Store (which is either the default context Store, a named context Store, or
@@ -1001,7 +1008,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1001
1008
  * ): ComponentReturnType;
1002
1009
  * ```
1003
1010
  *
1004
- * See the <ValuesInHtmlTable /> (React) demo for this component in action.
1011
+ * See the <ValuesInHtmlTable /> (React) demo for this component in action:
1012
+ *
1013
+ * ![ValuesInHtmlTable example](/shots/valuesinhtmltable-react-demo.png
1014
+ * "ValuesInHtmlTable example")
1005
1015
  *
1006
1016
  * The component's props identify which Row to render based on Table Id, Row Id,
1007
1017
  * and Store (which is either the default context Store, a named context Store,
@@ -1137,7 +1147,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1137
1147
  * ): ComponentReturnType;
1138
1148
  * ```
1139
1149
  *
1140
- * See the <SliceInHtmlTable /> (React) demo for this component in action.
1150
+ * See the <SliceInHtmlTable /> (React) demo for this component in action:
1151
+ *
1152
+ * ![SliceInHtmlTable example](/shots/sliceinhtmltable-react-demo.png
1153
+ * "SliceInHtmlTable example")
1141
1154
  *
1142
1155
  * The component's props identify which Slice to render based on Index Id, Slice
1143
1156
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1300,7 +1313,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1300
1313
  * ```
1301
1314
  *
1302
1315
  * See the <RelationshipInHtmlTable /> (React) demo for this component in
1303
- * action.
1316
+ * action:
1317
+ *
1318
+ * ![RelationshipInHtmlTable example](
1319
+ * /shots/relationshipinhtmltable-react-demo.png
1320
+ * "RelationshipInHtmlTable example")
1304
1321
  *
1305
1322
  * The component's props identify which Relationship to render based on
1306
1323
  * Relationship Id and Relationships object (which is either the default context
@@ -1483,7 +1500,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1483
1500
  * ```
1484
1501
  *
1485
1502
  * See the <ResultTableInHtmlTable /> (React) demo for this component in
1486
- * action.
1503
+ * action:
1504
+ *
1505
+ * ![ResultTableInHtmlTable example](
1506
+ * /shots/resulttableinhtmltable-react-demo.png
1507
+ * "ResultTableInHtmlTable example")
1487
1508
  *
1488
1509
  * The component's props identify which ResultTable to render based on query Id,
1489
1510
  * and Queries object (which is either the default context Queries object, a
@@ -1641,7 +1662,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1641
1662
  * ```
1642
1663
  *
1643
1664
  * See the <ResultSortedTableInHtmlTable /> (React) demo for this component in
1644
- * action.
1665
+ * action:
1666
+ *
1667
+ * ![ResultSortedTableInHtmlTable example](
1668
+ * /shots/resultsortedtableinhtmltable-react-demo.png
1669
+ * "ResultSortedTableInHtmlTable example")
1645
1670
  *
1646
1671
  * The component's props identify which ResultTable to render based on query Id,
1647
1672
  * and Queries object (which is either the default context Queries object, a
@@ -1820,7 +1845,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1820
1845
  * ): ComponentReturnType;
1821
1846
  * ```
1822
1847
  *
1823
- * See the <EditableCellView /> (React) demo for this component in action.
1848
+ * See the <EditableCellView /> (React) demo for this component in action:
1849
+ *
1850
+ * ![EditableCellView example](/shots/editablecellview-react-demo.png
1851
+ * "EditableCellView example")
1824
1852
  *
1825
1853
  * The component's props identify which Cell to render based on Table Id, Row
1826
1854
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1902,7 +1930,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1902
1930
  * ): ComponentReturnType;
1903
1931
  * ```
1904
1932
  *
1905
- * See the <EditableValueView /> (React) demo for this component in action.
1933
+ * See the <EditableValueView /> (React) demo for this component in action:
1934
+ *
1935
+ * ![EditableValueView example](/shots/editablevalueview-react-demo.png
1936
+ * "EditableValueView example")
1906
1937
  *
1907
1938
  * The component's props identify which Value to render based on Table Id, Row
1908
1939
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -1970,7 +2001,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1970
2001
  * The SortedTablePaginator component renders a paginator for a sorted table.
1971
2002
  *
1972
2003
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
1973
- * action.
2004
+ * action:
2005
+ *
2006
+ * ![SortedTablePaginator example](/shots/sortedtablepaginator-react-demo.png
2007
+ * "SortedTablePaginator example")
1974
2008
  *
1975
2009
  * The component displays 'previous' and 'next' buttons for paging through the
1976
2010
  * Table if there are more Row Ids than fit in each page. The component will
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (React) demo for this component in action.
47
+ * See the <Inspector /> (React) demo for this component in action:
48
+ *
49
+ * ![Inspector example](/shots/inspector-react-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (React) demo for this component in action.
47
+ * See the <Inspector /> (React) demo for this component in action:
48
+ *
49
+ * ![Inspector example](/shots/inspector-react-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -688,7 +688,10 @@ export type SortedTablePaginatorProps = {
688
688
  * Store as an HTML <table> element, and registers a listener so that any
689
689
  * changes to that result will cause a re-render.
690
690
  *
691
- * See the <TableInHtmlTable /> (Svelte) demo for this component in action.
691
+ * See the <TableInHtmlTable /> (Svelte) demo for this component in action:
692
+ *
693
+ * ![TableInHtmlTable example](/shots/tableinhtmltable-svelte-demo.png
694
+ * "TableInHtmlTable example")
692
695
  *
693
696
  * The component's props identify which Table to render based on Table Id, and
694
697
  * Store (which is either the default context Store, a named context Store, or
@@ -849,7 +852,11 @@ export const TableInHtmlTable: Component<
849
852
  * that any changes to that result will cause a re-render.
850
853
  *
851
854
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
852
- * action.
855
+ * action:
856
+ *
857
+ * ![SortedTableInHtmlTable example](
858
+ * /shots/sortedtableinhtmltable-svelte-demo.png
859
+ * "SortedTableInHtmlTable example")
853
860
  *
854
861
  * The component's props identify which Table to render based on Table Id, and
855
862
  * Store (which is either the default context Store, a named context Store, or
@@ -1034,7 +1041,10 @@ export const SortedTableInHtmlTable: Component<
1034
1041
  * as an HTML <table> element, and registers a listener so that any changes to
1035
1042
  * that result will cause a re-render.
1036
1043
  *
1037
- * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action.
1044
+ * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action:
1045
+ *
1046
+ * ![ValuesInHtmlTable example](/shots/valuesinhtmltable-svelte-demo.png
1047
+ * "ValuesInHtmlTable example")
1038
1048
  *
1039
1049
  * The component's props identify which Row to render based on Table Id, Row Id,
1040
1050
  * and Store (which is either the default context Store, a named context Store,
@@ -1174,7 +1184,10 @@ export const ValuesInHtmlTable: Component<
1174
1184
  * <table> element, and registers a listener so that any changes to that result
1175
1185
  * will cause a re-render.
1176
1186
  *
1177
- * See the <SliceInHtmlTable /> (Svelte) demo for this component in action.
1187
+ * See the <SliceInHtmlTable /> (Svelte) demo for this component in action:
1188
+ *
1189
+ * ![SliceInHtmlTable example](/shots/sliceinhtmltable-svelte-demo.png
1190
+ * "SliceInHtmlTable example")
1178
1191
  *
1179
1192
  * The component's props identify which Slice to render based on Index Id, Slice
1180
1193
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1343,7 +1356,11 @@ export const SliceInHtmlTable: Component<
1343
1356
  * so that any changes to that result will cause a re-render.
1344
1357
  *
1345
1358
  * See the <RelationshipInHtmlTable /> (Svelte) demo for this component in
1346
- * action.
1359
+ * action:
1360
+ *
1361
+ * ![RelationshipInHtmlTable example](
1362
+ * /shots/relationshipinhtmltable-svelte-demo.png
1363
+ * "RelationshipInHtmlTable example")
1347
1364
  *
1348
1365
  * The component's props identify which Relationship to render based on
1349
1366
  * Relationship Id and Relationships object (which is either the default context
@@ -1527,7 +1544,11 @@ export const RelationshipInHtmlTable: Component<
1527
1544
  * listener so that any changes to that result will cause a re-render.
1528
1545
  *
1529
1546
  * See the <ResultTableInHtmlTable /> (Svelte) demo for this component in
1530
- * action.
1547
+ * action:
1548
+ *
1549
+ * ![ResultTableInHtmlTable example](
1550
+ * /shots/resulttableinhtmltable-svelte-demo.png
1551
+ * "ResultTableInHtmlTable example")
1531
1552
  *
1532
1553
  * The component's props identify which ResultTable to render based on query Id,
1533
1554
  * and Queries object (which is either the default context Queries object, a
@@ -1693,7 +1714,11 @@ export const ResultTableInHtmlTable: Component<
1693
1714
  * re-render.
1694
1715
  *
1695
1716
  * See the <ResultSortedTableInHtmlTable /> (Svelte) demo for this component in
1696
- * action.
1717
+ * action:
1718
+ *
1719
+ * ![ResultSortedTableInHtmlTable example](
1720
+ * /shots/resultsortedtableinhtmltable-svelte-demo.png
1721
+ * "ResultSortedTableInHtmlTable example")
1697
1722
  *
1698
1723
  * The component's props identify which ResultTable to render based on query Id,
1699
1724
  * and Queries object (which is either the default context Queries object, a
@@ -1879,7 +1904,10 @@ export const ResultSortedTableInHtmlTable: Component<
1879
1904
  * that can be edited in a web browser, and registers a listener so that any
1880
1905
  * changes to that result will cause a re-render.
1881
1906
  *
1882
- * See the <EditableCellView /> (Svelte) demo for this component in action.
1907
+ * See the <EditableCellView /> (Svelte) demo for this component in action:
1908
+ *
1909
+ * ![EditableCellView example](/shots/editablecellview-svelte-demo.png
1910
+ * "EditableCellView example")
1883
1911
  *
1884
1912
  * The component's props identify which Cell to render based on Table Id, Row
1885
1913
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1949,7 +1977,10 @@ export const EditableCellView: Component<
1949
1977
  * that can be edited in a web browser, and registers a listener so that any
1950
1978
  * changes to that result will cause a re-render.
1951
1979
  *
1952
- * See the <EditableValueView /> (Svelte) demo for this component in action.
1980
+ * See the <EditableValueView /> (Svelte) demo for this component in action:
1981
+ *
1982
+ * ![EditableValueView example](/shots/editablevalueview-svelte-demo.png
1983
+ * "EditableValueView example")
1953
1984
  *
1954
1985
  * The component's props identify which Value to render based on Table Id, Row
1955
1986
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -2021,7 +2052,10 @@ export const EditableValueView: Component<
2021
2052
  * The SortedTablePaginator component renders a paginator for a sorted table.
2022
2053
  *
2023
2054
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
2024
- * action.
2055
+ * action:
2056
+ *
2057
+ * ![SortedTablePaginator example](/shots/sortedtablepaginator-svelte-demo.png
2058
+ * "SortedTablePaginator example")
2025
2059
  *
2026
2060
  * The component displays 'previous' and 'next' buttons for paging through the
2027
2061
  * Table if there are more Row Ids than fit in each page. The component will
@@ -668,7 +668,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
668
668
  * >;
669
669
  * ```
670
670
  *
671
- * See the <TableInHtmlTable /> (Svelte) demo for this component in action.
671
+ * See the <TableInHtmlTable /> (Svelte) demo for this component in action:
672
+ *
673
+ * ![TableInHtmlTable example](/shots/tableinhtmltable-svelte-demo.png
674
+ * "TableInHtmlTable example")
672
675
  *
673
676
  * The component's props identify which Table to render based on Table Id, and
674
677
  * Store (which is either the default context Store, a named context Store, or
@@ -835,7 +838,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
835
838
  * ```
836
839
  *
837
840
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
838
- * action.
841
+ * action:
842
+ *
843
+ * ![SortedTableInHtmlTable example](
844
+ * /shots/sortedtableinhtmltable-svelte-demo.png
845
+ * "SortedTableInHtmlTable example")
839
846
  *
840
847
  * The component's props identify which Table to render based on Table Id, and
841
848
  * Store (which is either the default context Store, a named context Store, or
@@ -1028,7 +1035,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1028
1035
  * >;
1029
1036
  * ```
1030
1037
  *
1031
- * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action.
1038
+ * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action:
1039
+ *
1040
+ * ![ValuesInHtmlTable example](/shots/valuesinhtmltable-svelte-demo.png
1041
+ * "ValuesInHtmlTable example")
1032
1042
  *
1033
1043
  * The component's props identify which Row to render based on Table Id, Row Id,
1034
1044
  * and Store (which is either the default context Store, a named context Store,
@@ -1176,7 +1186,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1176
1186
  * >;
1177
1187
  * ```
1178
1188
  *
1179
- * See the <SliceInHtmlTable /> (Svelte) demo for this component in action.
1189
+ * See the <SliceInHtmlTable /> (Svelte) demo for this component in action:
1190
+ *
1191
+ * ![SliceInHtmlTable example](/shots/sliceinhtmltable-svelte-demo.png
1192
+ * "SliceInHtmlTable example")
1180
1193
  *
1181
1194
  * The component's props identify which Slice to render based on Index Id, Slice
1182
1195
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1351,7 +1364,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1351
1364
  * ```
1352
1365
  *
1353
1366
  * See the <RelationshipInHtmlTable /> (Svelte) demo for this component in
1354
- * action.
1367
+ * action:
1368
+ *
1369
+ * ![RelationshipInHtmlTable example](
1370
+ * /shots/relationshipinhtmltable-svelte-demo.png
1371
+ * "RelationshipInHtmlTable example")
1355
1372
  *
1356
1373
  * The component's props identify which Relationship to render based on
1357
1374
  * Relationship Id and Relationships object (which is either the default context
@@ -1543,7 +1560,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1543
1560
  * ```
1544
1561
  *
1545
1562
  * See the <ResultTableInHtmlTable /> (Svelte) demo for this component in
1546
- * action.
1563
+ * action:
1564
+ *
1565
+ * ![ResultTableInHtmlTable example](
1566
+ * /shots/resulttableinhtmltable-svelte-demo.png
1567
+ * "ResultTableInHtmlTable example")
1547
1568
  *
1548
1569
  * The component's props identify which ResultTable to render based on query Id,
1549
1570
  * and Queries object (which is either the default context Queries object, a
@@ -1717,7 +1738,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1717
1738
  * ```
1718
1739
  *
1719
1740
  * See the <ResultSortedTableInHtmlTable /> (Svelte) demo for this component in
1720
- * action.
1741
+ * action:
1742
+ *
1743
+ * ![ResultSortedTableInHtmlTable example](
1744
+ * /shots/resultsortedtableinhtmltable-svelte-demo.png
1745
+ * "ResultSortedTableInHtmlTable example")
1721
1746
  *
1722
1747
  * The component's props identify which ResultTable to render based on query Id,
1723
1748
  * and Queries object (which is either the default context Queries object, a
@@ -1911,7 +1936,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1911
1936
  * >;
1912
1937
  * ```
1913
1938
  *
1914
- * See the <EditableCellView /> (Svelte) demo for this component in action.
1939
+ * See the <EditableCellView /> (Svelte) demo for this component in action:
1940
+ *
1941
+ * ![EditableCellView example](/shots/editablecellview-svelte-demo.png
1942
+ * "EditableCellView example")
1915
1943
  *
1916
1944
  * The component's props identify which Cell to render based on Table Id, Row
1917
1945
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1995,7 +2023,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1995
2023
  * >;
1996
2024
  * ```
1997
2025
  *
1998
- * See the <EditableValueView /> (Svelte) demo for this component in action.
2026
+ * See the <EditableValueView /> (Svelte) demo for this component in action:
2027
+ *
2028
+ * ![EditableValueView example](/shots/editablevalueview-svelte-demo.png
2029
+ * "EditableValueView example")
1999
2030
  *
2000
2031
  * The component's props identify which Value to render based on Table Id, Row
2001
2032
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -2067,7 +2098,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2067
2098
  * The SortedTablePaginator component renders a paginator for a sorted table.
2068
2099
  *
2069
2100
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
2070
- * action.
2101
+ * action:
2102
+ *
2103
+ * ![SortedTablePaginator example](/shots/sortedtablepaginator-svelte-demo.png
2104
+ * "SortedTablePaginator example")
2071
2105
  *
2072
2106
  * The component displays 'previous' and 'next' buttons for paging through the
2073
2107
  * Table if there are more Row Ids than fit in each page. The component will
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (Svelte) demo for this component in action.
47
+ * See the <Inspector /> (Svelte) demo for this component in action:
48
+ *
49
+ * ![Inspector example](/shots/inspector-svelte-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (Svelte) demo for this component in action.
47
+ * See the <Inspector /> (Svelte) demo for this component in action:
48
+ *
49
+ * ![Inspector example](/shots/inspector-svelte-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
package/agents.md CHANGED
@@ -309,9 +309,13 @@ from source code and markdown files.
309
309
  source files for guides on the website.
310
310
 
311
311
  4. **Generated Files**: `/releases.md` and `/readme.md` in the root are
312
- **GENERATED** from `/site/guides/17_releases.md` and `/site/home/index.md`.
312
+ **GENERATED** from `/site/guides/18_releases.md` and `/site/home/index.md`.
313
313
  **Never edit the generated files directly**.
314
314
 
315
+ 5. **Guide Redirects**: To preserve old guide URLs, leave a markdown stub at the
316
+ old path whose summary is just `-> /new-url`. The site generator hides these
317
+ from navigation and renders them as meta-refresh redirect pages.
318
+
315
319
  ### Documentation Testing
316
320
 
317
321
  TinyBase has automated tests that validate all inline code examples in
@@ -361,7 +365,7 @@ npx vitest run ./test/unit/documentation.test.ts --retry=0
361
365
 
362
366
  1. **API Documentation**: Edit `docs.js` file next to the type definition
363
367
  2. **Guide Content**: Edit markdown files in `/site/guides/`
364
- 3. **Release Notes**: Edit `/site/guides/17_releases.md` (not `/releases.md`)
368
+ 3. **Release Notes**: Edit `/site/guides/18_releases.md` (not `/releases.md`)
365
369
  4. **Always run documentation tests** after changes to verify examples work
366
370
 
367
371
  ## Creating New Schematizers
@@ -494,7 +498,7 @@ All code examples in a guide file are concatenated and executed as a test:
494
498
 
495
499
  When adding a new feature:
496
500
 
497
- 1. **Update `/site/guides/17_releases.md`** (NOT `/releases.md`):
501
+ 1. **Update `/site/guides/18_releases.md`** (NOT `/releases.md`):
498
502
  - Add new version section at the top
499
503
  - Include working code example that will be tested
500
504
  - Link to relevant guide if applicable