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

Author: dylanh724

README.md

@@ -13,7 +13,7 @@ To make changes to our docs, you can open a pull request in this repository. You
 git clone ssh://[email protected]/<username>/spacetime-docs
 ```
 
-3. Make your edits to the docs that you want to make + test them locally (see Testing Your Edits below)
+3. Make your edits to the docs that you want to make + test them locally
 4. Commit your changes:
 
 ```bash

docs/getting-started.md

@@ -2,29 +2,32 @@
 
 To develop SpacetimeDB applications locally, you will need to run the Standalone version of the server.
 
-1. [Install](/install) the SpacetimeDB CLI (Command Line Interface).
+1. [Install](/install) the SpacetimeDB CLI (Command Line Interface)
 2. Run the start command
 
 ```bash
 spacetime start
 ```
 
-The server listens on port `3000` by default. You can change this by using the `--listen-addr` option described below.
+The server listens on port `3000` by default, customized via `--listen-addr`.
 
-SSL is not supported in standalone mode.
+⚠️ SSL is not supported in standalone mode.
 
 ## What's Next?
 
-You are ready to start developing SpacetimeDB modules. We have a quickstart guide for each supported server-side language:
+You are ready to start developing SpacetimeDB modules. See below for a quickstart guide for both client and server (module) languages/frameworks.
+
+### Server (Module)
 
 - [Rust](/docs/modules/rust/quickstart)
 - [C#](/docs/modules/c-sharp/quickstart)
 
-Then you can write your client application. We have a quickstart guide for each supported client-side language:
+⚡**Note:** Rust is [roughly 2x faster](https://faun.dev/c/links/faun/c-vs-rust-vs-go-a-performance-benchmarking-in-kubernetes/) than C#
+
+### Client
 
 - [Rust](/docs/sdks/rust/quickstart)
-- [C#](/docs/sdks/c-sharp/quickstart)
+- [C# (Standalone)](/docs/sdks/c-sharp/quickstart) 
+- [C# (Unity)](/docs/unity/part-1)
 - [Typescript](/docs/sdks/typescript/quickstart)
-- [Python](/docs/sdks/python/quickstart)
-
-We also have a [step-by-step tutorial](/docs/unity/part-1) for building a multiplayer game in Unity3d.
+- [Python](/docs/sdks/python/quickstart)

docs/modules/c-sharp/index.md

@@ -42,6 +42,7 @@ static partial class Module
     {
         // We can skip (or explicitly set to zero) auto-incremented fields when creating new rows.
         var person = new Person { Name = name, Age = age };
+        
         // `Insert()` method is auto-generated and will insert the given row into the table.
         person.Insert();
         // After insertion, the auto-incremented fields will be populated with their actual values.
@@ -211,8 +212,10 @@ public partial struct Person
 
     // Finds a row in the table with the given value in the `Id` column and returns it, or `null` if no such row exists.
     public static Person? FindById(int id);
+    
     // Deletes a row in the table with the given value in the `Id` column and returns `true` if the row was found and deleted, or `false` if no such row exists.
     public static bool DeleteById(int id);
+    
     // Updates a row in the table with the given value in the `Id` column and returns `true` if the row was found and updated, or `false` if no such row exists.
     public static bool UpdateById(int oldId, Person newValue);
 }

docs/modules/c-sharp/quickstart.md

@@ -16,7 +16,18 @@ If you haven't already, start by [installing SpacetimeDB](/install). This will i
 
 ## Install .NET 8
 
-Next we need to [install .NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) so that we can build and publish our module. .NET 8.0 is the earliest to have the `wasi-experimental` workload that we rely on.
+Next we need to [install .NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) so that we can build and publish our module.
+
+You may already have .NET 8 and can be checked:
+```bash
+dotnet --list-sdks
+```
+
+.NET 8.0 is the earliest to have the `wasi-experimental` workload that we rely on, but requires manual activation:
+
+```bash
+dotnet workload install wasi-experimental
+```
 
 ## Project structure
 
@@ -35,7 +46,11 @@ spacetime init --lang csharp server
 
 ## Declare imports
 
-`spacetime init` should have pre-populated `server/Lib.cs` with a trivial module. Clear it out, so we can write a module that's still pretty simple: a bare-bones chat server.
+`spacetime init` generated a few files: 
+
+1. Open `server/StdbModule.csproj` to generate a .sln file for intellisense/validation support.
+2. Open `server/Lib.cs`, a trivial module.
+3. Clear it out, so we can write a new module that's still pretty simple: a bare-bones chat server.
 
 To the top of `server/Lib.cs`, add some imports we'll be using:
 
@@ -235,7 +250,7 @@ public static void OnDisconnect(DbEventArgs dbEventArgs)
     else
     {
         // User does not exist, log warning
-        Log($"Warning: No user found for disconnected client.");
+        Log("Warning: No user found for disconnected client.");
     }
 }
 ```
@@ -250,12 +265,16 @@ From the `quickstart-chat` directory, run:
 spacetime publish --project-path server <module-name>
 ```
 
+```bash
+npm i wasm-opt -g
+```
+
 ## Call Reducers
 
 You can use the CLI (command line interface) to run reducers. The arguments to the reducer are passed in JSON format.
 
 ```bash
-spacetime call <module-name> send_message '["Hello, World!"]'
+spacetime call <module-name> send_message "Hello, World!"
 ```
 
 Once we've called our `send_message` reducer, we can check to make sure it ran by running the `logs` command.
@@ -288,4 +307,4 @@ spacetime sql <module-name> "SELECT * FROM Message"
 
 You've just set up your first database in SpacetimeDB! The next step would be to create a client module that interacts with this module. You can use any of SpacetimDB's supported client languages to do this. Take a look at the quick start guide for your client language of choice: [Rust](/docs/languages/rust/rust-sdk-quickstart-guide), [C#](/docs/languages/csharp/csharp-sdk-quickstart-guide), [TypeScript](/docs/languages/typescript/typescript-sdk-quickstart-guide) or [Python](/docs/languages/python/python-sdk-quickstart-guide).
 
-If you are planning to use SpacetimeDB with the Unity3d game engine, you can skip right to the [Unity Comprehensive Tutorial](/docs/unity/part-1) or check out our example game, [BitcraftMini](/docs/unity/part-3).
+If you are planning to use SpacetimeDB with the Unity game engine, you can skip right to the [Unity Comprehensive Tutorial](/docs/unity/part-1) or check out our example game, [BitcraftMini](/docs/unity/part-3).

docs/modules/rust/quickstart.md

@@ -269,4 +269,4 @@ You can find the full code for this module [in the SpacetimeDB module examples](
 
 You've just set up your first database in SpacetimeDB! The next step would be to create a client module that interacts with this module. You can use any of SpacetimDB's supported client languages to do this. Take a look at the quickstart guide for your client language of choice: [Rust](/docs/sdks/rust/quickstart), [C#](/docs/sdks/c-sharp/quickstart), [TypeScript](/docs/sdks/typescript/quickstart) or [Python](/docs/sdks/python/quickstart).
 
-If you are planning to use SpacetimeDB with the Unity3d game engine, you can skip right to the [Unity Comprehensive Tutorial](/docs/unity/part-1) or check out our example game, [BitcraftMini](/docs/unity/part-3).
+If you are planning to use SpacetimeDB with the Unity game engine, you can skip right to the [Unity Comprehensive Tutorial](/docs/unity/part-1) or check out our example game, [BitcraftMini](/docs/unity/part-3).

docs/sdks/c-sharp/quickstart.md

@@ -1,8 +1,8 @@
 # C# Client SDK Quick Start
 
-In this guide we'll show you how to get up and running with a simple SpacetimDB app with a client written in C#.
+In this guide we'll show you how to get up and running with a simple SpacetimeDB app with a client written in C#.
 
-We'll implement a command-line client for the module created in our Rust or C# Module Quickstart guides. Make sure you follow one of these guides before you start on this one.
+We'll implement a command-line client for the module created in our [Rust](../../modules/rust/quickstart.md) or [C# Module](../../modules/c-sharp/quickstart.md) Quickstart guides. Ensure you followed one of these guides before continuing.
 
 ## Project structure
 
@@ -12,7 +12,7 @@ Enter the directory `quickstart-chat` you created in the [Rust Module Quickstart
 cd quickstart-chat
 ```
 
-Within it, create a new C# console application project called `client` using either Visual Studio or the .NET CLI:
+Within it, create a new C# console application project called `client` using either Visual Studio, Rider or the .NET CLI:
 
 ```bash
 dotnet new console -o client
@@ -22,7 +22,7 @@ Open the project in your IDE of choice.
 
 ## Add the NuGet package for the C# SpacetimeDB SDK
 
-Add the `SpacetimeDB.ClientSDK` [NuGet package](https://www.nuget.org/packages/spacetimedbsdk) using Visual Studio NuGet package manager or via the .NET CLI
+Add the `SpacetimeDB.ClientSDK` [NuGet package](https://www.nuget.org/packages/spacetimedbsdk) using Visual Studio or Rider _NuGet Package Manager_ or via the .NET CLI:
 
 ```bash
 dotnet add package SpacetimeDB.ClientSDK
@@ -39,7 +39,7 @@ mkdir -p client/module_bindings
 spacetime generate --lang csharp --out-dir client/module_bindings --project-path server
 ```
 
-Take a look inside `client/module_bindings`. The CLI should have generated five files:
+Take a look inside `client/module_bindings`. The CLI should have generated five files under `module_bindings`:
 
 ```
 module_bindings
@@ -65,8 +65,10 @@ We will also need to create some global variables that will be explained when we
 ```csharp
 // our local client SpacetimeDB identity
 Identity? local_identity = null;
+
 // declare a thread safe queue to store commands in format (command, args)
 ConcurrentQueue<(string,string)> input_queue = new ConcurrentQueue<(string, string)>();
+
 // declare a threadsafe cancel token to cancel the process loop
 CancellationTokenSource cancel_token = new CancellationTokenSource();
 ```
@@ -75,10 +77,10 @@ CancellationTokenSource cancel_token = new CancellationTokenSource();
 
 We'll work outside-in, first defining our `Main` function at a high level, then implementing each behavior it needs. We need `Main` to do several things:
 
-1. Initialize the AuthToken module, which loads and stores our authentication token to/from local storage.
-2. Create the SpacetimeDBClient instance.
+1. Initialize the `AuthToken` module, which loads and stores our authentication token to/from local storage.
+2. Create the `SpacetimeDBClient` instance.
 3. Register callbacks on any events we want to handle. These will print to standard output messages received from the database and updates about users' names and online statuses.
-4. Start our processing thread, which connects to the SpacetimeDB module, updates the SpacetimeDB client and processes commands that come in from the input loop running in the main thread.
+4. Start our processing thread which connects to the SpacetimeDB module, updates the SpacetimeDB client and processes commands that come in from the input loop running in the main thread.
 5. Start the input loop, which reads commands from standard input and sends them to the processing thread.
 6. When the input loop exits, stop the processing thread and wait for it to exit.
 
@@ -154,7 +156,7 @@ string UserNameOrIdentity(User user) => user.Name ?? user.Identity.ToString()!.S
 
 void User_OnInsert(User insertedValue, ReducerEvent? dbEvent)
 {
-    if(insertedValue.Online)
+    if (insertedValue.Online)
     {
         Console.WriteLine($"{UserNameOrIdentity(insertedValue)} is online");
     }
@@ -178,20 +180,21 @@ We'll print an appropriate message in each of these cases.
 ```csharp
 void User_OnUpdate(User oldValue, User newValue, ReducerEvent dbEvent)
 {
-    if(oldValue.Name != newValue.Name)
+    if (oldValue.Name != newValue.Name)
     {
         Console.WriteLine($"{UserNameOrIdentity(oldValue)} renamed to {newValue.Name}");
     }
-    if(oldValue.Online != newValue.Online)
+    
+    if (oldValue.Online == newValue.Online)
+        return;
+        
+    if (newValue.Online)
     {
-        if(newValue.Online)
-        {
-            Console.WriteLine($"{UserNameOrIdentity(newValue)} connected.");
-        }
-        else
-        {
-            Console.WriteLine($"{UserNameOrIdentity(newValue)} disconnected.");
-        }
+        Console.WriteLine($"{UserNameOrIdentity(newValue)} connected.");
+    }
+    else
+    {
+        Console.WriteLine($"{UserNameOrIdentity(newValue)} disconnected.");
     }
 }
 ```
@@ -209,7 +212,7 @@ void PrintMessage(Message message)
 {
     var sender = User.FilterByIdentity(message.Sender);
     var senderName = "unknown";
-    if(sender != null)
+    if (sender != null)
     {
         senderName = UserNameOrIdentity(sender);
     }
@@ -219,7 +222,7 @@ void PrintMessage(Message message)
 
 void Message_OnInsert(Message insertedValue, ReducerEvent? dbEvent)
 {
-    if(dbEvent != null)
+    if (dbEvent != null)
     {
         PrintMessage(insertedValue);
     }
@@ -254,7 +257,11 @@ We'll test both that our identity matches the sender and that the status is `Fai
 ```csharp
 void Reducer_OnSetNameEvent(ReducerEvent reducerEvent, string name)
 {
-    if(reducerEvent.Identity == local_identity && reducerEvent.Status == ClientApi.Event.Types.Status.Failed)
+    bool localIdentityFailedToChangeName = 
+        reducerEvent.Identity == local_identity && 
+        reducerEvent.Status == ClientApi.Event.Types.Status.Failed;
+        
+    if (localIdentityFailedToChangeName)
     {
         Console.Write($"Failed to change name to {name}");
     }
@@ -268,7 +275,11 @@ We handle warnings on rejected messages the same way as rejected names, though t
 ```csharp
 void Reducer_OnSendMessageEvent(ReducerEvent reducerEvent, string text)
 {
-    if (reducerEvent.Identity == local_identity && reducerEvent.Status == ClientApi.Event.Types.Status.Failed)
+    bool localIdentityFailedToSendMessage = 
+        reducerEvent.Identity == local_identity && 
+        reducerEvent.Status == ClientApi.Event.Types.Status.Failed;
+
+    if (localIdentityFailedToSendMessage)
     {
         Console.Write($"Failed to send message {text}");
     }
@@ -282,7 +293,10 @@ Once we are connected, we can send our subscription to the SpacetimeDB module. S
 ```csharp
 void OnConnect()
 {
-    SpacetimeDBClient.instance.Subscribe(new List<string> { "SELECT * FROM User", "SELECT * FROM Message" });
+    SpacetimeDBClient.instance.Subscribe(new List<string> 
+    { 
+        "SELECT * FROM User", "SELECT * FROM Message" 
+    });
 }
 ```
 
@@ -370,12 +384,12 @@ void InputLoop()
     while (true)
     {
         var input = Console.ReadLine();
-        if(input == null)
+        if (input == null)
         {
             break;
         }
 
-        if(input.StartsWith("/name "))
+        if (input.StartsWith("/name "))
         {
             input_queue.Enqueue(("name", input.Substring(6)));
             continue;
@@ -421,4 +435,4 @@ dotnet run --project client
 
 ## What's next?
 
-Congratulations! You've built a simple chat app using SpacetimeDB. You can look at the C# SDK Reference for more information about the client SDK. If you are interested in developing in the Unity3d game engine, check out our Unity3d Comprehensive Tutorial and BitcraftMini game example.
+Congratulations! You've built a simple chat app using SpacetimeDB. You can look at the C# SDK Reference for more information about the client SDK. If you are interested in developing in the Unity game engine, check out our Unity3d Comprehensive Tutorial and BitcraftMini game example.