From 44ac5e67924ec9e4d3ee2c0ce889f4cfe2fb4615 Mon Sep 17 00:00:00 2001 From: a16raj Date: Thu, 20 Aug 2026 13:19:38 +0530 Subject: [PATCH] fix(docs): add blank lines around Tab contents and fix CI on forks The MDX parser used by the documentation site requires blank lines between block-level components (like \\) and their markdown or component children (like \\) to correctly parse them as block content rather than inline HTML. This fixes the broken formatting reported when multiple tabs are present, where the first tab lacked trailing newlines (fixes #5566). Additionally, this adds a repository check to \docs-sync.yml\ and \mirror-swift.yml\ to prevent them from failing when run on forks where the required PAT secrets are not present. --- .github/workflows/docs-sync.yml | 1 + .github/workflows/mirror-swift.yml | 1 + docs/content/docs/authentication.mdx | 4 ++++ docs/content/docs/connections.mdx | 3 +++ docs/content/docs/crash-course.mdx | 12 ++++++++++++ 5 files changed, 21 insertions(+) diff --git a/.github/workflows/docs-sync.yml b/.github/workflows/docs-sync.yml index 6fe0cfaea0..738203e512 100644 --- a/.github/workflows/docs-sync.yml +++ b/.github/workflows/docs-sync.yml @@ -11,6 +11,7 @@ on: jobs: sync: + if: github.repository == 'rivet-dev/actors' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/mirror-swift.yml b/.github/workflows/mirror-swift.yml index 0d16e43061..28d6b3ad49 100644 --- a/.github/workflows/mirror-swift.yml +++ b/.github/workflows/mirror-swift.yml @@ -11,6 +11,7 @@ on: jobs: mirror: + if: github.repository == 'rivet-dev/actors' runs-on: ubuntu-latest steps: - name: Checkout diff --git a/docs/content/docs/authentication.mdx b/docs/content/docs/authentication.mdx index 1ff904881e..436f31e33c 100644 --- a/docs/content/docs/authentication.mdx +++ b/docs/content/docs/authentication.mdx @@ -8,16 +8,20 @@ skill: true + Actors are private by default on Rivet Cloud. Only requests with the publishable token can interact with actors. - **Backend-only actors**: If your publishable token is only included in your backend, then authentication is not necessary. - **Frontend-accessible actors**: If your publishable token is included in your frontend, then implementing authentication is recommended. + + Actors are public by default on self-hosted Rivet. Anyone can access them without a token. - **Only accessible within private network**: If Rivet is only accessible within your private network, then authentication is not necessary. - **Rivet exposed to the public internet**: If Rivet is configured to accept traffic from the public internet, then implementing authentication is recommended. + diff --git a/docs/content/docs/connections.mdx b/docs/content/docs/connections.mdx index 2f7ad4e3c4..a925899783 100644 --- a/docs/content/docs/connections.mdx +++ b/docs/content/docs/connections.mdx @@ -25,7 +25,9 @@ For example: There are two ways to define an actor's connection state: + + Define connection state as a constant value: @@ -34,6 +36,7 @@ There are two ways to define an actor's connection state: + Create connection state dynamically with a function called for each connection: diff --git a/docs/content/docs/crash-course.mdx b/docs/content/docs/crash-course.mdx index 4e7b05d5e9..81fc67082e 100644 --- a/docs/content/docs/crash-course.mdx +++ b/docs/content/docs/crash-course.mdx @@ -46,9 +46,12 @@ Persistent data that survives restarts, crashes, and deployments. State is persi + + + @@ -80,9 +83,12 @@ Temporary data that doesn't survive restarts. Use for non-serializable objects ( + + + @@ -114,9 +120,12 @@ Access the current connection via `c.conn` or all connected clients via `c.conns + + + @@ -186,9 +195,12 @@ Use `UserError` to throw errors that are safely returned to clients. Pass `metad + + +