Noa
bb43213245
# Description of Changes Currently based on #3361 Implements most of the TS module API (not yet a function for type aliases). # Expected complexity level and risk <!-- How complicated do you think these changes are? Grade on a scale from 1 to 5, where 1 is a trivial change, and 5 is a deep-reaching and complex change. This complexity rating applies not only to the complexity apparent in the diff, but also to its interactions with existing and future code. If you answered more than a 2, explain what is complex about the PR, and what other components it interacts with in potentially concerning ways. --> # Testing <!-- Describe any testing you've done, and any testing you'd like your reviewers to do, so that you're confident that all the changes work as expected! --> - [x] Extremely basic module stuff works - [ ] <!-- maybe a test you want a reviewer to do, so they can check it off when they're satisfied. --> --------- Signed-off-by: Noa <coolreader18@gmail.com> Co-authored-by: Tyler Cloutier <cloutiertyler@aol.com> Co-authored-by: = <cloutiertyler@gmail.com> Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
Migration note
We are in the process of moving from the spacetimedb-docs repo to the docs subdirectory of SpacetimeDB. Any new changes should be made there. The spacetimedb-docs repo will only be updated on release. Apologies in advance for any sharp edges while the migration is in progress.
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>/SpacetimeDB
cd SpacetimeDB/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.
CLI Reference Section
- Run
cargo run --features markdown-docs -p spacetimedb-cli > docs/docs/cli-reference.md - Run
pnpm format
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.