mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-12 18:57:51 -04:00
Phoebe Goldman
d4c80b4de1
# Description of Changes Somehow (apparently after #3494) we wound up with a bunch of duplicate folders in our repo, both the old title-case names and the new lower-case names. All of the remaining files in the title-case directories have their last change in #3343, well before #3494, so I don't believe we're losing any intermediate changes by deleting them. I'm not sure how this happened, but it seems to be an easy fix. # API and ABI breaking changes N/a # Expected complexity level and risk 2 - some small possibility that I accidentally deleted an intentional change that got borked by a merge conflict or something. I don't think I did, tho, based on the age of the git blame on the files deleted here. # Testing None
SpacetimeDB Documentation
This repository contains the markdown files which are used to display documentation on our website. This documentation is built using Docusaurus.
Making Edits
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 the
docsdirectory. - Install the dependencies:
pnpm install - Run the development server:
pnpm dev, which will start a local server and open a browser window. All changes you make to the markdown files will be reflected live in the browser.
License
This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details