README: state, not usage, in the features table; drop the 2.x migration guide #105

Merged

yuris merged 1 commit from readme-features-table into main

2026-08-22 03:28:46 +00:00

yuris commented

2026-08-22 03:27:04 +00:00

Owner

Two things, both subtractive.

The features table states implementation, not usage. Every row used to carry call syntax — stdb.builder():with_url(...):with_database(...), sub:on_applied, the whole ctx member list — which duplicated the wiki's API reference and made the table hard to read as the one thing it is: a comparison. Now it answers one question per row, on each side: ✅ shipped, ❌ absent, ➖ not applicable. Syntax stays on the page that documents syntax.

Wire formats split into BSATN wire and JSON wire, because the two have different answers on the official side and one row could not say so with an emoji.

The 2.x migration guide goes. Nobody is on 2.x, so it was a guide out of a place no reader is. The ctx-first break is recorded in the v3.0.0 release annotation for anyone who arrives later wondering what changed between the tags, which is where a changelog belongs.

Net -52/+29. No behaviour, no other file: the table and the upgrade note existed only in the README, so nothing else went stale. Checked: no reference to "Upgrading from" survives anywhere in the repo or the wiki, both [sdkapi]/[sdkconn] link definitions are still used, every table row is well formed, and the README's quickstart still parses and runs against the live server (README_EXAMPLE_OK).

Two things, both subtractive. **The features table states implementation, not usage.** Every row used to carry call syntax — `stdb.builder():with_url(...):with_database(...)`, `sub:on_applied`, the whole `ctx` member list — which duplicated the wiki's API reference and made the table hard to read as the one thing it is: a comparison. Now it answers one question per row, on each side: ✅ shipped, ❌ absent, ➖ not applicable. Syntax stays on the page that documents syntax. `Wire formats` split into **BSATN wire** and **JSON wire**, because the two have different answers on the official side and one row could not say so with an emoji. **The 2.x migration guide goes.** Nobody is on 2.x, so it was a guide out of a place no reader is. The `ctx`-first break is recorded in the [v3.0.0 release annotation](https://git.nokopia.com/yuris/spacetimedb-defold/releases/tag/v3.0.0) for anyone who arrives later wondering what changed between the tags, which is where a changelog belongs. Net **-52/+29**. No behaviour, no other file: the table and the upgrade note existed only in the README, so nothing else went stale. Checked: no reference to "Upgrading from" survives anywhere in the repo or the wiki, both `[sdkapi]`/`[sdkconn]` link definitions are still used, every table row is well formed, and the README's quickstart still parses and runs against the live server (`README_EXAMPLE_OK`).

yuris added 1 commit

2026-08-22 03:27:04 +00:00

README: state, not usage, in the features table; drop the 2.x migration guide

ci / ci (pull_request) Successful in 1m26s

Details

5fb000d593

The table was carrying call syntax for every row, which duplicated the wiki's
API reference and made a comparison hard to read as one. It answers one
question now - is this implemented, on which side - with the syntax left to the
page that documents it. Two rows split out of the old "Wire formats" entry,
because BSATN and JSON have different answers on the official side.

The upgrade guide goes because there is nothing to upgrade: nobody is on 2.x.
The v3.0.0 release annotation records the ctx-first break for anyone who
arrives later wondering what changed, which is where that belongs.

yuris merged commit c0f84ff8c3 into main

2026-08-22 03:28:46 +00:00

yuris referenced this pull request from a commit

2026-08-22 03:28:46 +00:00

README: state, not usage, in the features table; drop the 2.x migration guide (#105)

yuris referenced this pull request from a commit

2026-08-22 07:04:43 +00:00

stdb: drop the v1 JSON wire, and ship it as 4.0.0

yuris referenced this pull request from a commit

2026-08-22 07:06:52 +00:00

stdb: drop the v1 JSON wire, and ship it as 4.0.0

yuris referenced this pull request