Skip to content

Commit 48ccf41

Browse files
committed
Merge branch 'jdetter/csharp-release-changes' of ssh://github.com/clockworklabs/SpacetimeDB into jdetter/csharp-release-changes
2 parents 57a5531 + 8c2472d commit 48ccf41

92 files changed

Lines changed: 4419 additions & 2348 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/csharp-test.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,6 @@ jobs:
114114
exit 1
115115
}
116116
117-
# The Unity meta file check does not let us ignore directories, so we just temporarily move them out
118-
- name: Move ignored directories from check
119-
run: |
120-
# Move ignored directories temporarily
121-
mv 'sdks/csharp/release~' '/tmp/release~' || true
122-
123117
- name: Check Unity meta files
124118
uses: DeNA/unity-meta-check@v3
125119
with:
@@ -128,12 +122,6 @@ jobs:
128122
env:
129123
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
130124

131-
- name: Restore ignored directories from check
132-
run: |
133-
# Move ignored directories temporarily
134-
mv '/tmp/release~' 'sdks/csharp/release~' || true
135-
136-
137125
- name: Start SpacetimeDB
138126
run: |
139127
spacetime start &
File renamed without changes.
Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
---
22
title: Overview
3+
id: overview
34
slug: /
45
---
56

67
import Tabs from '@theme/Tabs';
78
import TabItem from '@theme/TabItem';
9+
import { InstallCardLink } from "@site/src/components/InstallCardLink";
10+
import { CardLink } from "@site/src/components/CardLink";
11+
import { CardLinkGrid } from "@site/src/components/CardLinkGrid";
12+
import { QuickstartLinks } from "@site/src/components/QuickstartLinks";
13+
import DocsList from "@site/src/components/DocsList";
814

915
# SpacetimeDB Documentation
1016

1117
## Installation
1218

13-
You can run SpacetimeDB as a standalone database server via the `spacetime` CLI tool.
19+
You can get started by first installing the `spacetime` CLI tool. The `spacetime` CLI tool makes it extremely easy to manage your databases and deployments.
1420

15-
You can find the instructions to install the CLI tool for your platform [here](https://spacetimedb.com/install).
21+
<InstallCardLink />
1622

17-
To get started running your own standalone instance of SpacetimeDB check out our [Getting Started Guide](/getting-started).
23+
## Quickstart Guides
24+
25+
Choose your favorite language and follow one of our quickstart guides to get started building your first app with SpacetimeDB.
26+
27+
<QuickstartLinks />
1828

1929
## What is SpacetimeDB?
2030

@@ -82,20 +92,20 @@ You write SQL queries specifying what information a client is interested in -- f
8292

8393
Every SpacetimeDB database contains a collection of [stored procedures](https://en.wikipedia.org/wiki/Stored_procedure) and schema definitions. Such a collection is called a **module**, which can be written in C# or Rust. They specify a database schema and the business logic that responds to client requests. Modules are administered using the `spacetime` CLI tool.
8494

85-
- [Rust](/modules/rust) - [(Quickstart)](/modules/rust/quickstart)
86-
- [C#](/modules/c-sharp) - [(Quickstart)](/modules/c-sharp/quickstart)
95+
- [Rust](/modules/rust) - [(Quickstart)](/docs/quickstarts/rust)
96+
- [C#](/modules/c-sharp) - [(Quickstart)](/docs/quickstarts/c-sharp)
8797

8898
### Client-side SDKs
8999

90100
**Clients** are applications that connect to SpacetimeDB databases. The `spacetime` CLI tool supports automatically generating interface code that makes it easy to interact with a particular database.
91101

92-
- [Rust](/sdks/rust) - [(Quickstart)](/sdks/rust/quickstart)
93-
- [C#](/sdks/c-sharp) - [(Quickstart)](/sdks/c-sharp/quickstart)
94-
- [TypeScript](/sdks/typescript) - [(Quickstart)](/sdks/typescript/quickstart)
102+
- [Rust](/sdks/rust) - [(Quickstart)](/docs/quickstarts/rust)
103+
- [C#](/sdks/c-sharp) - [(Quickstart)](/docs/quickstarts/c-sharp)
104+
- [TypeScript](/sdks/typescript) - [(Quickstart)](/docs/quickstarts/typescript)
95105

96106
### Unity
97107

98-
SpacetimeDB was designed first and foremost as the backend for multiplayer Unity games. To learn more about using SpacetimeDB with Unity, jump on over to the [SpacetimeDB Unity Tutorial](/unity/part-1).
108+
SpacetimeDB was designed first and foremost as the backend for multiplayer Unity games. To learn more about using SpacetimeDB with Unity, jump on over to the [SpacetimeDB Unity Tutorial](/docs/tutorials/unity/part-1).
99109

100110
## Key architectural concepts
101111

@@ -111,7 +121,7 @@ A database exports [tables](#table), which store data, and [reducers](#reducer),
111121

112122
A database's schema and business logic is specified by a piece of software called a **module**. Modules can be written in C# or Rust.
113123

114-
(Technically, a SpacetimeDB module is a [WebAssembly module](https://developer.mozilla.org/en-US/docs/WebAssembly) that imports a specific low-level [WebAssembly ABI](/webassembly-abi) and exports a small number of special functions. However, the SpacetimeDB [server-side libraries](#module-libraries) hide these low-level details. As a developer, writing a module is mostly like writing any other C# or Rust application, except for the fact that a [special CLI tool](https://spacetimedb.com/install) is used to deploy the application.)
124+
(Technically, a SpacetimeDB module is a [WebAssembly module](https://developer.mozilla.org/en-US/docs/WebAssembly) that imports a specific low-level [WebAssembly ABI](/webassembly-abi) and exports a small number of special functions. However, the SpacetimeDB [server-side libraries](#module-libraries) hide these low-level details. As a developer, writing a module is mostly like writing any other C# or Rust application, except for the fact that a [special CLI tool](pathname:///install) is used to deploy the application.)
115125

116126
### Table
117127

@@ -346,4 +356,4 @@ A user has a single [`Identity`](#identity), but may open multiple connections t
346356
Follow our [Quick Start](/getting-started) guide!
347357

348358
1. How do I create a Unity game with SpacetimeDB?
349-
Follow our [Unity Tutorial](/unity) guide!
359+
Follow our [Unity Tutorial](/docs/tutorials/unity) guide!
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /getting-started
55

66
To develop SpacetimeDB databases locally, you will need to run the Standalone version of the server.
77

8-
1. [Install](https://spacetimedb.com/install) the SpacetimeDB CLI (Command Line Interface)
8+
1. [Install](pathname:///install) the SpacetimeDB CLI (Command Line Interface)
99
2. Run the start command:
1010

1111
```bash
@@ -33,14 +33,14 @@ You are now ready to start developing SpacetimeDB modules. See below for a quick
3333

3434
### Server (Module)
3535

36-
- [Rust](/modules/rust/quickstart)
37-
- [C#](/modules/c-sharp/quickstart)
36+
- [Rust](/docs/quickstarts/rust)
37+
- [C#](/docs/quickstarts/c-sharp)
3838

3939
**Note:** Rust is [roughly 2x faster](https://faun.dev/c/links/faun/c-vs-rust-vs-go-a-performance-benchmarking-in-kubernetes/) than C#
4040

4141
### Client
4242

43-
- [Rust](/sdks/rust/quickstart)
44-
- [C# (Standalone)](/sdks/c-sharp/quickstart)
45-
- [C# (Unity)](/unity/part-1)
46-
- [Typescript](/sdks/typescript/quickstart)
43+
- [Rust](/docs/quickstarts/rust)
44+
- [C# (Standalone)](/docs/quickstarts/c-sharp)
45+
- [C# (Unity)](/docs/tutorials/unity/part-1)
46+
- [Typescript](/docs/quickstarts/typescript)

0 commit comments

Comments
 (0)