Commit Graph

263 Commits

Author SHA1 Message Date
joshua-spacetime 43a1632bd7 Document LIMIT and COUNT (#178)
Closes #177.
2025-02-24 14:08:26 -08:00
Mario Montoya ec14d20f2c Fix auto_inc attribute name (#175) 2025-02-21 13:06:57 -05:00
Noa 3bccc079cd Rename satn.md -> sats-json.md (#158) 2025-02-20 23:45:22 -06:00
Mario Montoya fa321015da Add link to the cli (#171) 2025-02-20 11:17:48 -05:00
Zeke Foppa 860edb405b CLI docs (#168)
* [bfops/cli-docs]: CLI docs

* [bfops/cli-docs]: fix?

* [bfops/cli-docs]: manual backticks

* [bfops/cli-docs]: manual bold

* [bfops/cli-docs]: manual bold

* [bfops/cli-docs]: add README for maintaining CLI reference docs

* [bfops/cli-docs]: maybe fix code?

* [bfops/cli-docs]: tweak <code>

* [bfops/cli-docs]: tweak code

* [bfops/cli-docs]: update

---------

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2025-02-18 17:02:37 -08:00
joshua-spacetime 094f6c95c2 Remove WebSocket api docs and all references to them (#165)
Closes #164.

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-02-12 08:28:10 -08:00
Phoebe Goldman 6c11c8609e Style guide: add formatting advice for GUI elements and menu paths (#129)
* Style guide: add formatting advice for menu items

* Generalize guidance to all GUI elements, not just menu paths
2025-02-08 00:39:35 -05:00
Tyler Cloutier f26e9cc912 Small TS SDK Quickstart Fixes (#157)
Updated quickstart url
2025-02-08 00:38:59 -05:00
joshua-spacetime 8355ac2630 docs(70): The 1.0 SQL spec
Closes #70.
2025-02-03 15:20:08 -08:00
Phoebe Goldman 3c15d8a06c Update Rust client SDK docs for SpacetimeDB#2118 (#130) 2025-01-28 13:18:13 -05:00
Tyler Cloutier 2ab7e5e8ed Updated the TypeScript quickstart guide to use the new 1.0 API (#141)
* Updated the quickstart guide to use the new 1.0 API

* Completed quickstart rewrite

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Clarification

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Wrong type of quotes

* Update docs/sdks/typescript/quickstart.md

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

* Update docs/sdks/typescript/quickstart.md

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

* Apply suggestions from code review

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
Co-authored-by: rekhoff <r.ekhoff@clockworklabs.io>

* Address review comments

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
Co-authored-by: rekhoff <r.ekhoff@clockworklabs.io>
2025-01-27 19:41:07 -05:00
rekhoff 011187d730 Changed subscript to SubscribeToAllTables (#155)
Missed updating the HandleConnect from `Subscribe("SELECT * FROM *"` to `SubscribeToAllTables()` in the updated code block on page 3.
2025-01-27 15:45:45 -08:00
rekhoff 80e886a85d Rekhoff/unity blackhol.io tutorial switcher (#140)
* Unified Rust and C# documentation for Blackhol.io

Creates a single markdown file for each page, containing both Rust and C# server implementations, using the following format:
:::rust
# A rust section
:::
:::csharp
# A csharp section
:::
The visibility of each section should then be controlled by a dropdown on the website itself, leveraging tooling not contained in this branch.

* Updated language code blocks to clarify the block refers to the server's language

Prepped the combined documents to specifically tag for the server side code such that:
:::server-rust
A rust server implementation section.
:::
:::server-csharp
A csharp server implementation section.
:::
And in a future additionally update the documentation to differentiate the client portion too, like:
:::client-unity
A Unity client implementation section.
:::

* Update part-4.md

Added additional clarification that the linked repo contained content beyond the scope of the tutorial.

* Updated subscriptions to match new API format

* Small fixes to unity tutorial index page

* Added a note about column names to the C# tutorial

* Merged a section which was now abutting another section

* Clarified where you are supposed to put C# reducers

* Small, mostly whitespace fixes

---------

Co-authored-by: Tyler Cloutier <cloutiertyler@aol.com>
2025-01-24 14:59:10 -08:00
Tyler Cloutier 0db1dc0a6f Update quickstart.md 2025-01-18 01:15:13 -05:00
Tyler Cloutier 9a33bfc8a9 Addresses feedback that John provided (#137)
* Addresses feedback that John provided

* Fixed broken link
2025-01-17 21:08:09 -05:00
james gilles 20a8ce2a74 Add remark to style guide inspired by SpacetimeDB#2050 (#133) 2025-01-16 10:48:41 -05:00
Tyler Cloutier c2e4314bcc Made fixes to the tutorial for changes that were introduced to the C# in RC3 (#135) 2025-01-15 22:59:34 -05:00
Tyler Cloutier 96710dab99 Blackholio Tutorial Update (#128)
* First commit to test images

* Progress on the unity tutorial

* moar docs

* Part 3 incoming

* Part 3 and almost part 4!

* Finalized part 4 and deleted unused files

* Small fixes and clarifications

* Review typos and fixes

* Fixed link validation for images

* Removed the reference to an image which is going to be moving

* Fixed the tsconfig issue (it was not actually using the tsconfig)

* Shortened titles

* Just testing something

* Undo change

* Consistent headers

* Commenting out images for now

* Missed an image
2025-01-15 21:12:20 -05:00
james gilles bade25de08 Add vocabulary to style guide, update index.md accordingly (#126)
* Add vocabulary to style guide, update index.md accordingly

* s/runs/hosts/

* Update STYLE.md

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

* Rewrite 'Reducer'

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-01-08 14:09:11 -05:00
Tyler Cloutier a19cc48a18 Fix missing tick marks in Rust quickstart (#124)
Fixed missing tick marks in rust quickstart
2025-01-07 16:57:58 -05:00
Ingvar Stepanyan f2c0869db3 Describe how to define multiple tables with the same type (#113)
* Describe how to define multiple tables with the same type

Fixes #90.

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

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-01-06 21:12:47 +00:00
Tyler Cloutier 639b9269fe Switches to a canonical GitHub slugger format so that our slugs always match links generated on GitHub (#123)
Standardized slugging across docs and web
2025-01-03 16:06:09 -05:00
james gilles e09444959e Rewrite index.md (#111)
* Start rewriting index.md

* Docs rewrite

* Typo, SQL, more sales talk

* Address comments

* Finish addressing comments

* Update docs/index.md

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

* Address comments

* Clarify Identity section

* Fix links, clarify deployment section

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-01-03 14:30:18 -05:00
Tyler Cloutier 48bab90a41 Added a script to check the validity of docs links and a .github action (#122)
* Added a script to check the validity of docs links and a .github action

* Removed erroneous thing

* Switched the action trigger

* Added workflow to ensure that the nav.ts has been built to nav.js

* typo

* Build nav.ts

* typo thing

* Fixed script issue

* Fix

* Fixed a few links

* Added relative link resolution and fixed the broken links

* now checking fragments

* Now checking fragments properly and publishing some stats

* Forgot exit code

* Fix broken links

Well, in at least some cases, just remove broken links.

- The BSATN ref contained links to type defns, but didn't have type defns.
  Replace the links with plain text.
- HTTP database links for recovery-code related routes were getting mangled
  in some way I couldn't figure out, so the links weren't working
  despite their targets clearly existing.
  Conveniently, those routes have been removed,
  so remove the links and the corresponding sections.
- The JSON doc (erroneously called "SATN") contained typos,
  spelling "producttype" as "productype".
- C# SDK ref had links to a section on the `Address` type, but no such section.
  Replace the links with plain text.
- Rust SDK ref had a link getting mangled in a way I couldn't figure out.
  Simplify the section title so that the anchor name is predictable.
- TypeSciprt SDK ref used camelCase names in anchor links,
  but we downcase all section titles to create anchor names.

Also slap a section in README.md which says how to run the checker locally.

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2025-01-03 00:44:00 -05:00
Tyler Cloutier 85c137ca90 Added .DS_store to the .gitignore 2024-12-31 17:05:13 -05:00
Phoebe Goldman 0557d0ef4e Style guide for our docs (#110)
* WIP style guide for our docs

* More style

* Style: tutorials

* Add Tyler's suggestion re: avoiding passive voice

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

* Fill in grammar todos

---------

Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2024-11-26 10:57:41 -05:00
Phoebe Goldman 88eeb1c235 Add note about integer literal type inference (#100)
Companion to https://github.com/clockworklabs/SpacetimeDB/pull/1815

Also fix surrounding example code and text: you filter on indices, not columns.
2024-10-22 10:49:41 -04:00
Tyler Cloutier 89ab48cd9d Whitespace (#98) 2024-10-04 12:47:39 -04:00
Tyler Cloutier d8e7baa9d6 Added migration guide for v0.12 (#95)
* Added initial migration guide for v0.12

* My C# additions so far

* [v0.12-migration-guide]: build and style fixes

* Polished migration guide

* [v0.12-migration-guide]: docs update

* [v0.12-migration-guide]: C# TODOs

* [v0.12-migration-guide]: review

---------

Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2024-10-04 02:39:05 -04:00
John Detter 151039d8a2 Update rust index page for 0.12 (#89)
* Updated rust quickstart for 0.12

* Suggested tweaks

* Initial updates to the index file

* More updates to index, rolled back changes from another PR I'm working on

* Small improvements

---------

Co-authored-by: John Detter <no-reply@boppygames.gg>
2024-10-03 02:32:41 -05:00
John Detter aba173904e Updated rust quickstart for 0.12 (#88)
* Updated rust quickstart for 0.12

* Suggested tweaks

---------

Co-authored-by: John Detter <no-reply@boppygames.gg>
2024-10-03 02:32:27 -05:00
Phoebe Goldman 0fa848c818 Update Rust SDK ref for the new SDK (#93) 2024-10-02 12:35:23 -04:00
Phoebe Goldman 4267878a52 I didn't notice that auto-merge was enabled, so here's my review (#94) 2024-10-02 12:09:32 -04:00
John Detter 2a0ba3d07e Rust client quickstart updated for 0.12 (#92)
* Rust client updated for 0.12

* Small update

* More updates

* Final pass

---------

Co-authored-by: John Detter <no-reply@boppygames.gg>
2024-10-02 11:59:09 -04:00
Muthsera a749ccb3a8 Fixed code examples in rust reference regarding insertion (#42) 2024-09-24 11:54:25 -04:00
Arrel Neumiller 59a90c6793 Update part-2b-c-sharp.md (#75)
The intent is to throw an exception if the player already exists, not the other way 'round.
2024-09-24 11:35:13 -04:00
Egor Gavrilov 53d27b4ea6 Fix typo in modules/rust/index.md (#83)
Person -> Unique (because that belongs to `Unique` table)
2024-09-24 11:34:20 -04:00
Tyler Cloutier bb057fc220 Update quickstart.md (#84) 2024-09-24 11:33:31 -04:00
Puru Vijay 6412318479 prettier (#85)
Push
2024-09-19 12:38:41 +05:30
John Detter 9aad24ebd0 Fix broken tutorial package link (#86) 2024-09-16 11:08:13 -05:00
ike709 5631393053 Explicitly remind the reader to start the server (#43) 2024-08-29 17:55:13 -04:00
Tyler Cloutier 1b9e7d33c8 Update quickstart.md (#81)
Revert the find_by changes in rust which were never made.
2024-08-29 17:52:53 -04:00
Shubham Mishra c4759844e3 scheduler table doc update (#77) 2024-08-09 16:28:49 -07:00
Tyler Cloutier efcc979a6f Update quickstart.md (#74) 2024-08-09 16:28:38 -07:00
Shubham Mishra 73c3918c9b Shub/revert scheduler table doc (#76)
Revert "scheduler table doc update (#73)"

This reverts commit cd924d2049.
2024-08-02 11:55:37 -07:00
Shubham Mishra cd924d2049 scheduler table doc update (#73) 2024-08-02 23:25:52 +05:30
Zeke Foppa 7472a4ca87 Remove Python & update "coming soon" languages (#72)
* [bfops/remove-python]: do thing

* [bfops/remove-python]: empty

---------

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
2024-07-26 11:18:43 -07:00
Chip 6317ec1ecf CSharp Module tweak & Unity Tutorial part 1, 2b, 3 tweaks (#56)
* expanded on taggedenums and added examples for each special ReducerKind

Fixed a few typos/mistakes here and there also.

* fixed part2 hyperlinks

* fixed config version type

from Identity to uint

* update Throw => throw

* update log typo

* fix type on connect reducerkind from init=>connect

* private=>public for UpdatePlayerLoginState reducer

* remove double "publish" condenses it into one publish at the end after chat

* fixed name of GameManager file, tweaks to instructions

kept application.runInBackground (it wasn't included)

renamed many instances of "TutorialGameManager.cs" to "BitcraftMiniGameManager.cs" to represent accurate filename

* fixed onConnectError

* more TutorialGameManager renames to BitcraftMiniGameManager.cs and also a FilterByX fix

* added clarity to UIUsernameChooser.cs and LocalPlayer.cs -- Also fixed RemotePlayer.cs errors

* some small tweaks again to GameManager name

* updated tagged enums to reflect record usage and pattern matching

* filter -> find fixes

* expanded on taggedenums and added examples for each special ReducerKind

Fixed a few typos/mistakes here and there also.

* fixed config version type

from Identity to uint

* update Throw => throw

* update log typo

* fix type on connect reducerkind from init=>connect

* private=>public for UpdatePlayerLoginState reducer

* remove double "publish" condenses it into one publish at the end after chat

* fixed name of GameManager file, tweaks to instructions

kept application.runInBackground (it wasn't included)

renamed many instances of "TutorialGameManager.cs" to "BitcraftMiniGameManager.cs" to represent accurate filename

* fixed onConnectError

* more TutorialGameManager renames to BitcraftMiniGameManager.cs and also a FilterByX fix

* added clarity to UIUsernameChooser.cs and LocalPlayer.cs -- Also fixed RemotePlayer.cs errors

* some small tweaks again to GameManager name

* updated tagged enums to reflect record usage and pattern matching

* filter -> find fixes

* updated based on feedback
2024-06-28 00:39:46 +08:00
Ingvar Stepanyan 4e15ed15a5 Update C# tagged enum docs (#65)
* Update C# tagged enum docs

* Apply suggestions from code review

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

* Reword

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2024-06-18 16:13:16 +01:00
Ingvar Stepanyan 780884f8b4 Update docs for Consistent Filtering proposal (#68)
* Update docs for Consistent Filtering proposal

Updating docs for FilterBy methods across SDKs, adding docs for FindBy methods, and a couple of drive-by fixes for broken links.

* Update docs/sdks/c-sharp/index.md

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

---------

Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
2024-06-18 16:12:58 +01:00