Commit Graph

263 Commits

Author SHA1 Message Date
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
Tyler Cloutier 21b73f1e93 Update index.md 2023-12-07 18:34:55 -08:00
Tyler Cloutier b21ec868ab Update index.md 2023-12-07 18:30:11 -08:00
Tyler Cloutier 9f9bf57947 Revert "Reorganized the doc paths to match slugs and removed _category.json files" 2023-11-28 20:03:42 -08:00
Tyler Cloutier 3d014fb175 Reorganized the doc paths to match slugs and removed _category.json files 2023-11-28 17:21:24 -08:00
Tyler Cloutier 8ba8298447 Merge pull request #14 from clockworklabs/tyler/0.8/links-fix
[DO NOT MERGE UNTIL NEW WEB DOCS RELEASED] Fix most (but possibly not all) links in the docs
2023-11-28 13:31:02 -08:00
Nathaniel Richards 603b065b20 Created buildeR 2023-11-28 15:01:39 -05:00
Nathaniel Richards fe6b7b7f39 Update nav.ts 2023-11-28 13:57:48 -05:00
Tyler Cloutier 355d5fa919 Fix most (but possibly not all) links in the docs 2023-11-27 23:58:02 -08:00
Ingvar Stepanyan 31a977819d Ask users to install .NET 8 2023-11-27 20:41:01 +00:00
Tyler Cloutier 7d7437463c Added slugs to nav 2023-11-22 20:14:10 -08:00
Tyler Cloutier dbc1745ec0 Removed satisfies keyword for better Typescript compat 2023-11-21 22:52:36 -08:00
Tyler Cloutier 34320f9987 Merge pull request #12 from clockworklabs/docs-fix
Added nav.ts
2023-11-21 22:43:43 -08:00
Tyler Cloutier 6ef985f6c6 Added nav.ts 2023-11-21 22:39:35 -08:00
Tyler Cloutier 34fdd1f64e Update index.md 2023-11-21 19:34:27 -08:00
Tyler Cloutier 8dcb3c9571 Update index.md
Fixes a margin for the figure that kinda breaks it on mobile.
2023-11-20 17:49:34 -08:00
John Detter 7f1b1565e6 Fix syntax highlighting (#10)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2023-10-26 10:53:49 -05:00
Ingvar Stepanyan 17c3c12b4e Update C# docs for connect/disconnect (#9)
Update after the change in https://github.com/clockworklabs/SpacetimeDB/pull/309.
2023-10-25 11:53:25 +01:00
Kim Altintop 759a9eebf7 subscriptions: Inline incremental join design doc 2023-10-19 17:42:47 +02:00
John Detter 0c28c87b1d Addressing Chippy's feedback (#8)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2023-10-14 21:17:33 -05:00
John Detter c78d478b63 Unity Tutorial Updates (#7)
* Updated server side module

* More simplification

* More progress

* More updates

* Ready to start testing again

* Got through tutorial with some issues, going again

* Added warnings

* Small fix, this is ready to be released

---------

Co-authored-by: John Detter <no-reply@boppygames.gg>
2023-10-14 03:23:44 -05:00
John Detter 10f6d69473 This was an error in applying a patch (#6)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2023-10-12 21:01:39 -05:00
John Detter a6a2419d17 Applied Phoebe's patch 2023-10-12 15:16:44 -05:00
John Detter 4b1078b047 Fix Nuget command 2023-10-12 14:10:57 -05:00
John Detter 8bcfd164b1 Another small python quickstart fix 2023-10-12 11:48:14 -05:00
John Detter d94a485381 Python quickstart updated 2023-10-12 11:16:06 -05:00