Commit Graph

288 Commits

Author SHA1 Message Date
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
Ingvar Stepanyan 5b3c85662f Remove obsolete C# module imports (#67) 2024-06-18 16:12:24 +01:00
Ingvar Stepanyan 4b9b82c3c8 DbEventArgs -> ReducerContext in C# API docs (#66)
This API was recently renamed.
2024-06-18 16:12:13 +01:00
Ingvar Stepanyan 1f97c4230d Remove CreateInstance() from C# client docs (#69)
This method no longer exists - an instance with a default logger is set up automatically.
2024-06-18 16:01:53 +01:00
Zeke Foppa 1ce3b53a1c Update docs for making tables public/private (#63)
* [bfops/revert-premature-merge]: do revert

* [bfops/redo-61]: Redo #61

* [bfops/redo-61]: redo

* [bfops/redo-61]: add C#

* [bfops/redo-61]: review

* [bfops/redo-61]: review

---------

Co-authored-by: Zeke Foppa <github.com/bfops>
2024-06-14 08:59:41 -07:00
Kim Altintop 7cd55a06ad Update response of /database/info (#64)
To match changes in clockworklabs/spacetimedb#1305
2024-06-14 16:29:25 +02:00
Zeke Foppa c86e3daca6 Revert "Update docs for #[spacetimedb(table)] (#61)" (#62)
This reverts commit fce4df6f66.
2024-06-06 16:48:05 -04:00
Zeke Foppa fce4df6f66 Update docs for #[spacetimedb(table)] (#61)
* [bfops/public-tables]: update docs for #[spacetimedb(table)]

* [bfops/public-tables]: review

---------

Co-authored-by: Zeke Foppa <github.com/bfops>
2024-06-06 13:41:59 -07:00
Zeke Foppa 8c3fa75907 Remove incremental-joins.md (#1296)
* [bfops/rm-include-str]: empty

* [bfops/rm-include-str]: do thing

---------

Co-authored-by: Zeke Foppa <github.com/bfops>
2024-05-24 17:03:09 +00:00
Zeke Foppa f813a298d5 Fix the C# module link in part 1 (#55)
* [bfops/docs]: empty

* [bfops/docs]: one more fix

---------

Co-authored-by: Zeke Foppa <github.com/bfops>
2024-05-22 22:23:32 -04:00
Zeke Foppa f10dcf2ad8 Fix the C# module link in overview (#54)
* [bfops/docs]: C# fix

* [bfops/docs]: empty

---------

Co-authored-by: Zeke Foppa <github.com/bfops>
2024-05-22 20:01:27 -04:00
Puru Vijay fb32452b71 fix: Broken docs links (#53) 2024-05-22 16:49:14 -07:00
Puru Vijay 35640c113f fix: Unity tutorial slugs (#51) 2024-05-02 08:21:12 -07:00
Tyler Cloutier 6a071583f5 Revert "fix: Docs build, pnpm, vm evaluate (#46) (#50)" (#52)
This reverts commit 6c11566a23.
2024-05-02 10:11:54 -04:00
Tyler Cloutier 6c11566a23 fix: Docs build, pnpm, vm evaluate (#46) (#50)
* Push

* prettierrc

* Use cjs cuz current api require's it

* Prettier override for md

* fix 2b-c-sharp

Hopefully fixed the break introduced by pnpm

Fix to nav.js generation

Now just using tsc to build the file

type = commonjs

Co-authored-by: Puru Vijay <47742487+PuruVJ@users.noreply.github.com>
2024-05-02 10:02:46 -04:00
Tyler Cloutier 30f628dcfd Revert "fix: Docs build, pnpm, vm evaluate (#46)" (#48)
This reverts commit a92dbc08c4.
2024-05-01 23:57:58 -04:00
Puru Vijay a92dbc08c4 fix: Docs build, pnpm, vm evaluate (#46)
* Push

* prettierrc

* Use cjs cuz current api require's it

* Prettier override for md

* fix 2b-c-sharp
2024-05-01 22:20:11 +05:30
Dylan Hunt d6d31b594c Unity tutorial - C# parity (#31)
* doc: Onboarding impr, fixes, consistency, cleanup

refactor: Whats next cleanup, +unity, -bloat

Removed redundant text while there

refactor: Unity quickstart fixes, impr, prettify

refactor: Unity pt1 fixes, impr, prettify

fix(README): Rm "see test edits below" ref

* !exists

refactor(minor): General onboarding cleanup

* Shorter, prettier, consistent

fix(sdks/c#): Broken unitypackage url

feat(sdks/c#): Add OneTimeQuery api ref

* doc: Onboarding impr, fixes, consistency, cleanup

* fix: Rm redundant 'module_bindings' mention

* fix: Floating period, "arbitrary", "important":

- PR review change requests
- Additionally: hasUpdatedRecently fix and reformatting

* fix: Mentioned FilterBy, used FindBy

- Used FindBy since that was what the tutorial used, and also looking for a single Identity.
- Note: There may be a similar rust discrepancy in the Unity pt1 tutorial. It'll work with Filter, but just simply less consistent. Holding off on that since my Rust syntax knowledge !exists.

* fix(Unity-pt1): Rm copy+paste redundant comments

* Duplicate comments found both above and within funcs

* fix(unity): Rm unused using statement +merged info

* Removed `System.Runtime.CompilerServices`
* SpacetimeDB.Module seems to already include this (merged the info)

* refactor(minor): Code spacing for grouping/clarity

* feat: 'Standalone mode runs in foreground' memo

* At general quickstart for `spacetime start`

* refactor(unity-pt1): Standalone mode foreground memo

* Also, removed the "speed" loss mention of C#

* fix(syntaxErr): Fix err, keep FilterBy, handle null

- After a verbose discussion, we will eventually swap to FindBy for single-result queries, but not in this PR.
- For now, the syntax err is fixed by making the var nullable and suffixing a LINQ FirstOrDefault(). Approved by Tyler in Discord.
- We never *actually* created a player in the tutorial. This creates the player. Approved by Tyler in Discord.

* doc!(unity-tutorial): Add C# module parity + split

- Why?
  - Despite being a Unity tutorial (we 100% know the user knows C#), the server example used Rust.
  - This creates friction when the user is already learning multiple new things: The SpacetimeDB architecture, the CLI, the client SDK and server SDK. If they previously did not know Rust, this could add some weight to the onboarding friction.
  - The Unity tutorial could use an overview since it's quite lengthy and progressive.
  - Part1 should be split, anyway - it covers way too much for a single section to handle (especially since it jumps between client and server). Splitting between basic multiplayer + advanced makes things more-manageable and less intimidating.

- Before:
  - UNITY TUTORIAL
    - Part1 (Client + Rust Server)
    - Part2 (Resources and Scheduling)
    - Part3 (BitCraft Mini)

- After:
  - UNITY TUTORIAL - BASIC MULTIPLAYER
    - Overview
    - Part1 (Setup)
    - Part2a (Rust Server)
    - Part2b (C# Server)
    - Part3 (Client)
  - UNITY TUTORIAL - ADVANCED
    - Part4 (Resources and Scheduling)
    - Part5 (BitCraft Mini)

* Update docs/unity/part-2b-c-sharp.md

Rust -> C#

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

* Update docs/unity/part-2b-c-sharp.md

- `--lang=rust` to `=csharp`

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

* Update docs/unity/part-2b-c-sharp.md

- Rm RustRover mention

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

* Update docs/unity/part-2b-c-sharp.md

- Rust -> C#

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

* fix: "Next tutorial" mixups

* fix: Bad troubleshooting links

- Server issues shouldn't link to Client troubleshooting that has no answer

* Update docs/unity/part-2b-c-sharp.md

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

* Update docs/unity/part-2a-rust.md

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

---------

Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
2024-04-25 12:51:37 -07:00
Dylan Hunt 7b3b96cdd2 Dylan/onboarding-upgrades (#28)
* doc: Onboarding impr, fixes, consistency, cleanup

refactor: Whats next cleanup, +unity, -bloat

Removed redundant text while there

refactor: Unity quickstart fixes, impr, prettify

refactor: Unity pt1 fixes, impr, prettify

fix(README): Rm "see test edits below" ref

* !exists

refactor(minor): General onboarding cleanup

* Shorter, prettier, consistent

fix(sdks/c#): Broken unitypackage url

feat(sdks/c#): Add OneTimeQuery api ref

* doc: Onboarding impr, fixes, consistency, cleanup

* fix: Rm redundant 'module_bindings' mention

* fix: Floating period, "arbitrary", "important":

- PR review change requests
- Additionally: hasUpdatedRecently fix and reformatting

* fix: Mentioned FilterBy, used FindBy

- Used FindBy since that was what the tutorial used, and also looking for a single Identity.
- Note: There may be a similar rust discrepancy in the Unity pt1 tutorial. It'll work with Filter, but just simply less consistent. Holding off on that since my Rust syntax knowledge !exists.

* fix(Unity-pt1): Rm copy+paste redundant comments

* Duplicate comments found both above and within funcs

* fix(unity): Rm unused using statement +merged info

* Removed `System.Runtime.CompilerServices`
* SpacetimeDB.Module seems to already include this (merged the info)

* refactor(minor): Code spacing for grouping/clarity

* feat: 'Standalone mode runs in foreground' memo

* At general quickstart for `spacetime start`

* refactor(unity-pt1): Standalone mode foreground memo

* Also, removed the "speed" loss mention of C#

* fix(syntaxErr): Fix err, keep FilterBy, handle null

- After a verbose discussion, we will eventually swap to FindBy for single-result queries, but not in this PR.
- For now, the syntax err is fixed by making the var nullable and suffixing a LINQ FirstOrDefault(). Approved by Tyler in Discord.
- We never *actually* created a player in the tutorial. This creates the player. Approved by Tyler in Discord.

* fix: Remote player `is null` check removal
2024-03-29 17:16:35 +08:00
Phoebe Goldman 0e02ad425c WebSocket API ref: remove row_pk. (#29)
Re https://github.com/clockworklabs/SpacetimeDB/pull/840 .

We're removing the `row_pk` from the WebSocket API `TableRowOperation`,
as computing it has a major performance impact on the server.

This commit removes references to it from the WebSocket API reference.
2024-02-28 11:12:58 -08:00
Tyler Cloutier 00e3cada4a Update README.md 2024-01-24 12:26:38 -08:00
Piotr Sarnacki 8ef99bf8a0 Typescript SDK 0.8 changes (#21)
* Empty push to trigger a webhook

* Update TypeScript docs to 0.8
2023-12-18 20:07:19 +01:00
Tyler Cloutier e5b129eec1 Revert "Revert "Reorganized the doc paths to match slugs and removed _category.json files"" (#23)
This reverts commit 9f9bf57947.
2023-12-15 23:19:22 -08:00
Tyler Cloutier afd8fc216f Merge pull request #13 from clockworklabs/ingvar/net-8
Ask users to install .NET 8
2023-12-15 20:56:46 -08:00
Tyler Cloutier f3df3a4259 Update index.md 2023-12-15 16:24:16 -08:00
Tyler Cloutier 95a2224d2d Update index.md 2023-12-15 16:22:38 -08:00