mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-13 03:08:40 -04:00
Julien Lavocat
afb8c08b98
## Description of Changes - Migrate the documentation site to **Docusaurus**. - Add a **GitHub Action workflow** that runs `pnpm build` on pull requests targeting `master`. This command checks for broken links and images and ensures the site builds correctly. - Add a **GitHub Action workflow** to publish the docs automatically when a merge occurs on the `docs/release` branch. **Important**: The workflows haven't been tested yet due to the fact that they need to be merged first before being able to run. It's a fairly basic workflow I don't expect this to block anyone but anyways I will make another PR with the complete changes when I can actually run it. --- ## API and ABI Breaking Changes No breaking changes for **SpacetimeDB** users. Documentation contributors should experience minimal disruption — content is still written in Markdown. --- ## Expected Complexity Level and Risk **Complexity:** 3/5 **Reasons:** 1. Several adjustments were made to fit Docusaurus conventions: - Replaced our custom `:::server-rust` blocks with [Docusaurus `<Tabs/>` components](https://docusaurus.io/docs/markdown-features/tabs). - Converted “Note” callouts using [admonitions](https://docusaurus.io/docs/markdown-features/admonitions) instead of Markdown blockquotes. - Updated all images (including Unity tutorial ones, which were previously commented out). - Moved images from the DO bucket into the repository at `docs/static/images`. 2. Customized Docusaurus CSS and one component to apply our theme and color palette. --- ## Testing Tested locally. --- ## Review Notes This PR involves many file changes — a full code review is likely not productive. Instead, please focus on verifying that the **documentation content** was migrated correctly: - Review sections you’re familiar with to confirm accuracy. - Ensure formatting, links, and images render as expected. You can follow the updated **README** for instructions on running Docusaurus locally. --------- Signed-off-by: Julien Lavocat <JulienLavocat@users.noreply.github.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com> Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Co-authored-by: = <cloutiertyler@gmail.com>
1.8 KiB
1.8 KiB
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