Added RLS to llms.txt

.cursor/rules/spacetimedb.md

@@ -0,0 +1,4 @@
+- Before implementing SpacetimeDB code, reference the LLMs text and ensure you are using the proper syntax.
+- If you aren't certain about the SpacetimeDB implementation, ask the user
+- You're executing commands in Powershell, so make sure if you want to execute multiple commands to use ; instead of &&
+- All your commands that you execute start from the project directory, so make sure you take that into account when you're navigating directories.

.github/workflows/check-cli-reference.yml

@@ -0,0 +1,48 @@
+on:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: 'SpacetimeDB ref'
+        required: false
+        default: ''
+permissions: read-all
+
+name: Check CLI docs
+
+jobs:
+  cli_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find Git ref
+        shell: bash
+        run: |
+          echo "GIT_REF=${{ github.event.inputs.ref || 'master' }}" >>"$GITHUB_ENV"
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          repository: clockworklabs/SpacetimeDB
+          ref: ${{ env.GIT_REF }}
+      - uses: dsherret/rust-toolchain-file@v1
+      - name: Checkout docs
+        uses: actions/checkout@v4
+        with:
+          path: spacetime-docs
+      - name: Check for docs change
+        run: |
+          cargo run --features markdown-docs -p spacetimedb-cli > ../spacetime-docs/docs/cli-reference.md
+          cd spacetime-docs
+          # This is needed because our website doesn't render markdown quite properly.
+          # See the README in spacetime-docs for more details.
+          sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
+          sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
+          git status
+          if git diff --exit-code HEAD; then
+            echo "No docs changes detected"
+          else
+            echo "It looks like the CLI docs have changed."
+            echo "These docs are expected to match exactly the helptext generated by the CLI in SpacetimeDB (${{env.GIT_REF}})."
+            echo "Once a corresponding change has merged in SpacetimeDB, re-run this check."
+            echo "See https://github.com/clockworklabs/spacetime-docs/#cli-reference-section for more info on how to generate these docs from SpacetimeDB."
+            exit 1
+          fi

.github/workflows/check-links.yml

@@ -0,0 +1,26 @@
+name: Check Link Validity in Documentation
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16' # or the version of Node.js you're using
+
+      - name: Install dependencies
+        run: |
+          npm install
+
+      - name: Run link check
+        run: |
+          npm run check-links

.github/workflows/git-tree-checks.yml

@@ -0,0 +1,22 @@
+name: Git tree checks
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+  merge_group:
+permissions: read-all
+
+jobs:
+  check_base_ref:
+    name: Release branch restriction
+    runs-on: ubuntu-latest
+    steps:
+      - if: |
+          github.event_name == 'pull_request' &&
+          github.event.pull_request.base.ref == 'release' &&
+          ! startsWith(github.event.pull_request.head.ref, 'release-')
+        run: |
+          echo 'Only `release-*` branches are allowed to merge into the release branch `release`.'
+          echo 'Are you **sure** that you want to merge into release?'
+          echo 'Is this **definitely** just cherrypicking commits that are already in `master`?'
+          exit 1

.github/workflows/validate-nav-build.yml

@@ -0,0 +1,40 @@
+name: Validate nav.ts Matches nav.js
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  validate-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        run: |
+          npm install
+
+      - name: Backup existing nav.js
+        run: |
+          mv docs/nav.js docs/nav.js.original
+
+      - name: Build nav.ts
+        run: |
+          npm run build
+
+      - name: Compare generated nav.js with original nav.js
+        run: |
+          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'npm run build' and commit the updated file." && exit 1)
+
+      - name: Restore original nav.js
+        if: success() || failure()
+        run: |
+          mv docs/nav.js.original docs/nav.js

.gitignore

@@ -2,4 +2,4 @@
 .idea
 *.log
 node_modules
-dist
+.DS_store

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "jsxSingleQuote": false,
+  "trailingComma": "es5",
+  "endOfLine": "auto",
+  "printWidth": 80
+}

LICENSE.txt

@@ -172,3 +172,5 @@
       defend, and hold each Contributor harmless for any liability
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -13,13 +13,14 @@ To make changes to our docs, you can open a pull request in this repository. You
 git clone ssh://[email protected]/<username>/spacetime-docs
 ```
 
-3. Make your edits to the docs that you want to make + test them locally (see Testing Your Edits below)
+3. Make your edits to the docs that you want to make + test them locally
 4. Commit your changes:
 
 ```bash
 git add .
 git commit -m "A specific description of the changes I made and why"
 ```
+
 5. Push your changes to your fork as a branch
 
 ```bash
@@ -29,6 +30,22 @@ git push -u origin a-branch-name-that-describes-my-change
 
 6. 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.ts` you will have to run `npm run build` to generate a new `docs/nav.js` file.
+
+#### CLI Reference Section
+1. Make sure that https://github.com/clockworklabs/SpacetimeDB/pull/2276 is included in your `spacetimedb-cli` binary
+1. Run `cargo run --features markdown-docs -p spacetimedb-cli > cli-reference.md`
+
+We currently don't properly render markdown backticks and bolding that are inside of headers, so do these two manual replacements to make them look okay (these have only been tested on Linux):
+```bash
+sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
+sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
+```
+
+### 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.