To make changes to our docs, you can open a pull request in this repository. You can typically edit the files directly using the GitHub web interface, but you can also clone our repository and make your edits locally.

Instructions

Fork our repository
Clone your fork:

git clone ssh://git@github.com/<username>/SpacetimeDB
cd SpacetimeDB/docs

Make your edits to the docs that you want to make + test them locally (See Testing Locally)
Commit your changes:

git add .
git commit -m "A specific description of the changes I made and why"

Push your changes to your fork as a branch

git checkout -b a-branch-name-that-describes-my-change
git push -u origin a-branch-name-that-describes-my-change

Go to our GitHub and open a PR that references your branch in your fork on your GitHub

Docusaurus Documentation

For more information on how to use Docusaurus, see the Docusaurus documentation.

Testing Locally

Installation

Make sure you have Node.js installed (version 22 or higher is recommended).
Clone the repository and navigate to this directory.
Install the dependencies: pnpm install

Running the Development Server

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

License

This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details