Commit Graph

263 Commits

Author SHA1 Message Date
torjusik 14b34eb752 Update quickstart.md (#295)
fixed typo:
"Next add let's add" -> "Let's add"
2025-04-14 08:32:52 -07:00
8Times dd829e64de Typo fix quickstart.md (#294)
"SpacetimDB" -> "SpacetimeDB"
2025-04-14 08:31:16 -07:00
Tyler Cloutier c80417e0c1 Added a preliminary llms.md/.txt file to the repo to help LLMs generate code for users and understand SpacetimeDB (#286)
* Added a preliminary llms.md/.txt file to the repo to help LLMs generate code for users and understand SpacetimeDB

* Update llms.md

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Addressed some feedback

* Fixed up some stuff

* Added TypeScript SDK code

* Added subscription semantics section and small fixes

* Added info about ConnectionId and the reducer context

* Addressed comments

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-04-14 09:42:14 -04:00
Zeke Foppa 6e15325944 CI - Add release branch check (#270)
[bfops/release-branch-check]: Add release branch check

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2025-04-11 23:00:31 -07:00
joshua-spacetime dc7ae16c42 Update the timestamp format output by spacetime sql in the quickstart (#288)
Fixes #222.
2025-04-09 11:50:51 -07:00
heliam1 fade50a5c6 Fix typo (#289) 2025-04-09 08:35:59 -07:00
cjodo 160cb57972 fix(ts-sdk): correct the function signature of onConnectError (#255)
fix(sdk): correct the function signature of onConnectError
2025-04-04 12:17:09 -07:00
AdielMag 0818aff6bc Small fix on part-3.md (#264)
Update part-3.md
2025-04-04 12:16:29 -07:00
Colter Haycock 96aeffa375 Fixed Minor Typos in Unity Tutorial (#273)
* Update part-2.md

Minor typos

* Update part-2.md

reverting unnecessary change

* Update part-3.md

more tiny changes

* Update part-3.md

arena

* Update part-3.md
2025-04-04 12:15:53 -07:00
Kane Viggers fbf1543c29 Correction on c# server module quickstart (#253)
Table name is 'messages' not 'Messages'
2025-04-04 12:14:50 -07:00
Phoebe Goldman 8a0fc18afd TS quickstart: Install latest SDK, not specific version (#280)
The version listed here was outdated and included bugs.
I don't even know why we'd recommend a specific version,
instead of just telling people to install the latest release.
2025-04-02 13:05:15 -04:00
Oliver Davies 3887c479e6 Added "Connecting to Maincloud" section to part-4.md (#275)
* Update part-4.md

added a proper main cloud section

* Update part-4.md

* Update docs/unity/part-4.md

* Apply suggestions from code review

---------

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2025-03-24 23:24:56 -04:00
Mazdak Farrokhzad be4c2ef72c Adjust the BSATN doc to fit reality better (#216)
adjust BSATN doc to fit reality better
2025-03-12 14:08:47 +01:00
Tyler Cloutier efd9d86707 Updated tutorial for Blackholio/pull/19 (#163)
Updated tutorial for https://github.com/clockworklabs/Blackholio/pull/19

Co-authored-by: rekhoff <r.ekhoff@clockworklabs.io>
2025-03-11 17:24:55 -07:00
Zeke Foppa 521da1dc2f Explain spacetime login (#217)
[bfops/login-docs]: do thing

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2025-03-11 10:07:04 -07:00
Tyler Cloutier 9a88da8756 Removed double semi-colon (#254) 2025-03-10 09:11:05 -07:00
Noa 35c287dafa Clarify what is a valid module name (#252) 2025-03-07 11:10:42 -08:00
rekhoff 92d22ccbf2 Updated to correct old timestamp format. (#221) 2025-03-07 13:58:06 -05:00
Zeke Foppa a0e30f30e1 Remove stale references to removed CLI functions (#218)
[bfops/outdated-cli]: Remove stale references to removed CLI functions

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2025-03-06 08:27:19 -08:00
Zeke Foppa cfba6bbffd Update CLI docs for #2349 (#215)
* [bfops/fix-docs]: Update CLI docs for #2349

* [bfops/fix-docs]: missed one

---------

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2025-03-05 10:15:01 -08:00
John Detter 990fe06153 Bump typescript version to 1.0.2 (#213)
Bump version to 1.0.2

Co-authored-by: John Detter <no-reply@boppygames.gg>
2025-03-04 13:40:30 -06:00
John Detter 707446a4d2 Self-Hosted guide (#206)
* Standalone guide

* Several improvements

* Title update

* Updated nav.js

* Guide updated

* Small fix

* Guide working again after `--root-dir` change

* Finished + tested

* Apply suggestions from code review

Co-authored-by: Mazdak Farrokhzad <twingoow@gmail.com>

* Updates after review

* Update navigation

* Apply suggestions from code review

* Update docs/deploying/spacetimedb-standalone.md

* Update docs/deploying/spacetimedb-standalone.md

---------

Co-authored-by: John Detter <no-reply@boppygames.gg>
Co-authored-by: Mazdak Farrokhzad <twingoow@gmail.com>
2025-03-04 13:04:52 -06:00
Steve Biedermann d9ef0a6492 Fix code error and wrong code block (#210) 2025-03-04 12:34:52 -06:00
John Detter a97ca0164f Bump Typescript SDK Version in Quickstart (#208)
We didn't bump this version number

Co-authored-by: John Detter <no-reply@boppygames.gg>
2025-03-04 12:08:17 -05:00
rekhoff 6cce14ef93 Rekhoff/blackholio fixes (#205)
* Updates to blackholio tutorials

Page 3 - Fix duplicate code in Rust "disconnect reducer" instructions.
Page 4 - Update use of `CallerIdentity` to `Sender` in C# instructions.

* Fixes from running through Blackholio tutorial in Rust and C# on 1.0.0

* Minor formatting updates

* Minor formatting update

* Another minor format change

* Whitespace fix.

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

* Whitespace fix.

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

* Whitespace fix.

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

---------

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
2025-03-03 18:21:44 -08:00
Noa 973b62308f Describe how a JWT's sub/iss are translated into an Identity (#204) 2025-03-03 20:06:25 -05:00
joshua-spacetime 68a8daa6e3 C# sdk reference (#191)
Closes #192.
2025-03-03 16:36:56 -08:00
james gilles 52b80ef0b5 C# Module Library docs (#193)
* Most of the way to C# Module SDK docs

* Copy in more docs

* Mostly done

* Remove dead docs

* Apply suggestions from code review

Thanks Mazdak, also going to apply some of these to the Rust modules.

Co-authored-by: Mazdak Farrokhzad <twingoow@gmail.com>
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>

* Address review comments

---------

Co-authored-by: Mazdak Farrokhzad <twingoow@gmail.com>
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
2025-03-03 19:22:40 -05:00
Zeke Foppa b8c8a0f738 Add instructions for deploying to maincloud (#167)
* [bfops/deploying]: add instructions for deploying mainnet

* [bfops/deploying]: nav.ts

* [bfops/deploying]: nav.ts

* [bfops/deploying]: fix link?

* Update docs/deploying/maincloud.md

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

* Update docs/deploying/maincloud.md

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

* [bfops/deploying]: review

* Update docs/deploying/maincloud.md

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

* Add `/profile` as a known link

---------

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-03-03 19:06:20 -05:00
John Detter 8d6899768e Multiplayer bug fix in tutorial (#169)
* Multiplayer bug fix in tutorial

* Update part-4.md

Small fix

* removed reference to test input

This test input is not used during the tutorial and causes unused variable warnings

* Update part-4.md
2025-03-03 18:48:59 -05:00
Tyler Cloutier ebce4c2d3d Fixes the typescript quickstart for the new subscription API (#161)
* Updated quickstart url

* DBConnection -> DbConnection for TypeScript SDK

* Updated for the subscription update
2025-03-03 18:43:54 -05:00
Phoebe Goldman 12a1fdf0a7 Small doc fixes potpourri (#198)
* Remove hedging about table access from module quickstarts

We'll announce RLS when we announce it. For now, what we have is what we have.

* Remove hedging about supported module languages

This kind of thing belongs in a roadmap, not anywhere else in our docs.

* Fix :fingers_crossed: formatting of link to scheduled reducers

* Fix link

* List module langs in alphabetical order

Which also happens to be decreasing order of support and battle-tested-ness

* Re-order various and pages in sidebar

- Internals get their own section, and move down.
- Appendix gets its own section, instead of joining "Subscriptions."
- SQL and Subscriptions move up.

* Remove outdated guidance about tokens

We don't have "SpacetimeDB tokens" anymore, we just have regular OIDC JWTs.
We don't need to offer any special guidance about JWT hygiene.
2025-03-03 18:27:50 -05:00
rekhoff bc6ecabbb0 Updated with corrected table names to lower case, for compatibility w… (#195)
Updated with corrected table names to lower case, for compatibility with other quickstart-chat languages.
Updated with additional changes in https://github.com/clockworklabs/com.clockworklabs.spacetimedbsdk/pull/258
2025-03-03 13:45:08 -08:00
rekhoff 84acba23a4 Updates to blackhol.io tutorials (#194)
Updates to blackholio tutorials

Page 3 - Fix duplicate code in Rust "disconnect reducer" instructions.
Page 4 - Update use of `CallerIdentity` to `Sender` in C# instructions.
2025-03-03 12:46:50 -08:00
Phoebe Goldman 11b45c1d22 How-to: Incremental Migrations (#127)
* How-to: Incremental Migrations

This commit adds a how-to guide for defining "incremental migrations,"
a strategy for updating the schema of a database while maintaining compatibility
with outdated clients and without requiring a manual migration.

The code is not on GitHub yet,
as I'd like review on my choice of example before pushing the repository.
As such, the links to the code at the bottom of the new document are broken.

* Updates following review
2025-03-03 15:27:33 -05:00
Phoebe Goldman fdfe68ae14 Update Rust SDK ref, and also a few small fixes (#172)
* *Must* accept `ReducerContext`, not *may*

* Small fixes to Rust docs for database Identity and rename Address

* Update Rust SDK reference for various 1.0 API changes

* Fix broken links

* TOC and TODOs

* Rename `Address` to `ConnectionId` in index, fix some links

* Minor fixes I found while working through converting this to typescript

* Link to SQL ref

* Additional fixups found while rewriting TS ref

* Remove references to BitCraftMini

We no longer use this as an example.

Also, I'm pretty sure we stopped using that name ages ago.

* No UB from mixing `subscribe` and `subscribe_to_all_tables`

Co-authored-by: joshua-spacetime <josh@clockworklabs.io>

* Update TypeScript SDK reference (#181)

* Begin updating TypeScript SDK ref to match the new rust one

* Link to SQL ref from `subscribe` method

* Fill in the rest of the TypeScript SDK ref

* Fix copy-paste error: `subscribeToAllTables` should be camelCase

Co-authored-by: joshua-spacetime <josh@clockworklabs.io>

* Copy change from Rust SDK docs: no UB in `subscribeToAllTables`

Co-authored-by: joshua-spacetime <josh@clockworklabs.io>

* Fix casing of `withModuleName`

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

* Address Tyler's review

---------

Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

---------

Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2025-03-03 12:58:32 -05:00
Noa f38e72e57f Update docs for http api (#188)
* Update docs for http api

* Apply suggestions from code review

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Remove energy page

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-02-28 13:32:33 -06:00
Noa 7c878795d3 Add docs for standalone config.toml (#190)
* Add docs for standalone config.toml

* Update docs/cli-reference/standalone-config.md

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* pre formatting

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-02-28 13:32:12 -06:00
Phoebe Goldman 05f6de944d Update Rust client SDK quickstart for 1.0 API (#162)
* Begin revising rust client quickstart: update the code

* Revise Rust client SDK quickstart

A whole bunch of stuff has changed since this document was last updated.
Notably, I've chosen to re-order a bunch of sections,
since the previous structure of the document doesn't make much sense
after the 0.12 API rework.

* Fix credentials import issue

There are still warnings here but it builds now

* Fix warnings after pasting all this code into a fresh project

---------

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
2025-02-28 14:25:55 -05:00
Mario Montoya 04fd294627 Add missing LICENSE (#2319) 2025-02-28 14:32:59 +00:00
Mario Montoya 5943e6fc4f Document behaviour of SEQUENCES (#174)
* Document behaviour of SEQUENCES

* Update docs/appendix.md

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

---------

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-02-27 16:59:49 -05:00
Mazdak Farrokhzad 9e8463a59f Document reducer semantics wrt. transactionality (#185)
document reducer semantics wrt. transactionality
2025-02-27 16:32:04 +01:00
james gilles 8d04c3ef7b Move Rust Module SDK reference to docs.rs (#114)
Move rust reference to rustdoc
2025-02-26 14:49:31 -05:00
rekhoff d41bc73587 Update to C# Quickstart-Chat Server Module and Client SDK tutorial documents (#170)
* Initial code pass on updating server to 1.0.0

* Updated to work with current 1.0.0-rc4, master branches of SpacetimeDB and the CSharpSDK

* Minor edit for clarity

* No longer optional, ReducerContext is always the first argument

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Improved description of OnInsert and OnDelete callbacks

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Fixed capitalization.

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Fixed capitalization.

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* SDK language corrected and clarified.

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Added that the example is for the C# client and does not include server examples.

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Added comma for clarity

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Added comma for clarity

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>

* Applied requested changes to improve clarity

* Revised the SDK Client Quickstart to be more-in-line with the Rust Client Quickstart flow

* Added comments to code

* Replaced <module-name> with quickstart-chat

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-02-26 11:32:17 -08:00
joshua-spacetime 7ed444cf98 Remove 0.12 migration guide 2025-02-26 09:23:33 -08:00
joshua-spacetime 53d99af23d Remove references to testnet
Closes #183.
2025-02-25 12:18:15 -08:00
joshua-spacetime df263b1431 Remove reference to set energy-balance in http api
Closes #119.
2025-02-25 12:18:15 -08:00
joshua-spacetime 7b0ad990f6 Remove references to SpacetimeDB 0.6
Closes #118.
2025-02-25 12:18:15 -08:00
joshua-spacetime 9a86ea12dc API for mutable subscriptions (#166)
Closes #78.

Includes rust and csharp examples.
2025-02-25 09:57:09 -08:00
joshua-spacetime 9efb7f0558 Add best practices for Spacetime SQL (#180)
Closes #179.
2025-02-25 08:59:34 -08:00