rekhoff
80e886a85d
* Unified Rust and C# documentation for Blackhol.io Creates a single markdown file for each page, containing both Rust and C# server implementations, using the following format: :::rust # A rust section ::: :::csharp # A csharp section ::: The visibility of each section should then be controlled by a dropdown on the website itself, leveraging tooling not contained in this branch. * Updated language code blocks to clarify the block refers to the server's language Prepped the combined documents to specifically tag for the server side code such that: :::server-rust A rust server implementation section. ::: :::server-csharp A csharp server implementation section. ::: And in a future additionally update the documentation to differentiate the client portion too, like: :::client-unity A Unity client implementation section. ::: * Update part-4.md Added additional clarification that the linked repo contained content beyond the scope of the tutorial. * Updated subscriptions to match new API format * Small fixes to unity tutorial index page * Added a note about column names to the C# tutorial * Merged a section which was now abutting another section * Clarified where you are supposed to put C# reducers * Small, mostly whitespace fixes --------- Co-authored-by: Tyler Cloutier <cloutiertyler@aol.com>
SpacetimeDB Documentation
This repository contains the markdown files which are used to display documentation on our website.
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. To do this you can follow these instructions:
- Fork our repository
- Clone your fork:
git clone ssh://git@github.com/<username>/spacetime-docs
- Make your edits to the docs that you want to make + test them 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
NOTE! If you make a change to
nav.tsyou will have to runnpm run buildto generate a newdocs/nav.jsfile.
Checking Links
We have a CI job which validates internal links. You can run it locally with npm run check-links. This will print any internal links (i.e. links to other docs pages) whose targets do not exist, including fragment links (i.e. #-ey links to anchors).
License
This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details.