Documentation: SDK usage + API reference #12

New issue

Closed

opened 2026-08-19 06:49:40 +00:00 by yuris · 1 comment

yuris commented

2026-08-19 06:49:40 +00:00

Owner

README has the 10-line quickstart; real usage docs needed once vertical slice lands.

Usage guide (connect/subscribe/call_reducer/on_event)
API table for each module
Publish as Defold library dependency (tagged release)

README has the 10-line quickstart; real usage docs needed once vertical slice lands. - [ ] Usage guide (connect/subscribe/call_reducer/on_event) - [ ] API table for each module - [ ] Publish as Defold library dependency (tagged release)

yuris added the

phase:breadth

area:docs

labels

2026-08-19 06:49:40 +00:00

yuris commented

2026-08-19 12:07:19 +00:00

Author

Owner

Closing: all three checkboxes are done.

Usage guide — README covers connect / subscribe / call_reducer / on_event, plus the event table, droppable query sets, procedures, reconnect, identity persistence, and schema generation. Every non-obvious claim in it was captured from a live 2.8.2 server rather than inferred from docs.
API table for each module — new "API reference" section: stdb facade with the full connect option table, connection methods with their callback signatures, stdb.cache, stdb.schema, stdb.protocol.
Publish as a Defold library dependency — shipped in #13, including the Forgejo private-repo token quirk (basic auth 404s; use ?token=).

Also documented since this issue was filed: the two HTML5 traps from #8, and that an HTML5 build needs a patched extension-websocket until #15 lands.

Closing: all three checkboxes are done. - **Usage guide** — README covers connect / subscribe / call_reducer / on_event, plus the event table, droppable query sets, procedures, reconnect, identity persistence, and schema generation. Every non-obvious claim in it was captured from a live 2.8.2 server rather than inferred from docs. - **API table for each module** — new "API reference" section: `stdb` facade with the full `connect` option table, connection methods with their callback signatures, `stdb.cache`, `stdb.schema`, `stdb.protocol`. - **Publish as a Defold library dependency** — shipped in #13, including the Forgejo private-repo token quirk (basic auth 404s; use `?token=`). Also documented since this issue was filed: the two HTML5 traps from #8, and that an HTML5 build needs a patched extension-websocket until #15 lands.

yuris closed this issue

2026-08-19 12:07:19 +00:00

yuris referenced this issue from a commit

2026-08-19 13:04:16 +00:00

docs: HTML5 traps, an API reference, and the docker-free workflow