Configless #57
Configless #57
Conversation
|
|
||
| ### Binary Protocol | ||
|
|
||
| The SpacetimeDB binary WebSocket protocol, `v1.bin.spacetimedb`, encodes messages using [ProtoBuf 3](https://protobuf.dev), and reducer and row data using [BSATN](/docs/bsatn). | ||
| The SpacetimeDB binary WebSocket protocol, `v1.bin.spacetimedb`, encodes messages using [ProtoBuf 3](https://protobuf.dev), and reducer and row data using [BSATN](/docs/data-format/bsatn). | ||
|
|
||
| The binary protocol's messages are defined in [`client_api.proto`](https://github.com/clockworklabs/SpacetimeDB/blob/master/crates/client-api-messages/protobuf/client_api.proto). |
There was a problem hiding this comment.
This is broken as we don't use protobufs anymore. What should this be replaced with?
There was a problem hiding this comment.
Ah, we need to rewrite this whole page, pretty much. Perhaps we should replace it with a stub for now, and aim to rewrite it after all the WebSocket API changes we have planned.
There was a problem hiding this comment.
Note that the JSON parts are also wrong now. I think we should replace this whole file with something like:
The SpacetimeDB WebSocket protocol is currently changing rapidly. Stay tuned for stable formats for the BSATN protocol
v1.bin.spacetimedband the JSON protocolv1.text.spacetimedb. For now, you can check the definition of the exchanged messages.
There was a problem hiding this comment.
Noted. Will do so in a separate PR after this
|
@PuruVJ Spreading the config throughout the filesystem was how it used to be. We changed that (to copy the Bun structure) because it was very error prone. I don't think the meta.json file makes this better. |
|
What were the errors that could happen? |
|
People editing the docs were unaware of the equivalent of the |
Similar to our Proposal folder's file structure
POC for configless docs. Contrary to the name, these are infact quite config heavy. But all configruation is now spread across the entire filesystem structure of the docs. The filesystem, the metadata in meta.json and at the top of .md files will inform the final URLs and navbar structure on the website.