Skip to content

docs: fix daily docs audit drift - #5936

Open
clockwork-labs-bot wants to merge 8 commits into
masterfrom
bot/docs-audit
Open

clockwork-labs-bot wants to merge 8 commits into
masterfrom
bot/docs-audit

Conversation

@clockwork-labs-bot

@clockwork-labs-bot clockwork-labs-bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update the TypeScript client reference so TableHandle.count() returns bigint, matching crates/bindings-typescript/src/lib/table.ts and existing TypeScript SDK tests.
  • Clarify spacetime publish environment behavior: ordinary publishes preserve unspecified stored values by default, and optional values are removed only through explicit unset or replacement.
  • Fix the C# authentication guide's SpacetimeAuth connection reducer snippet so it is exported as [Reducer(ReducerKind.ClientConnected)] public static, matching the C# server module requirements.
  • Document procedure HTTP response decompression: outbound procedure HTTP requests now automatically accept and decode gzip/Brotli responses, and module code should not manually decompress those bodies.
  • Fix the TypeScript procedure transaction example so the b procedure argument is declared as t.string(), matching the myTable.b column inserted inside withTx.

Audit notes

  • Required PR preflight found open bot/docs-audit PR docs: fix daily docs audit drift #5936, so this run updated the existing PR branch.
  • Merged current origin/master into bot/docs-audit before adding audit fixes. On 2026-09-18, this brought in source PR Update railway deploy button to follow their requirements #5948, a localized Railway deploy-button docs update; no additional docs correction was needed for that change.
  • Commit-impact pass: source PR Implement persistent typed database environments #5887 introduced persistent typed database environments. The docs fix aligns the publish concept page with the new CLI reference, environment variables guide, implementation, and smoketests.
  • Commit-impact pass: source PR Add compression support to ctx.http.fetch #5698 enabled transparent gzip/Brotli decompression for procedure HTTP requests. The docs fix adds the user-visible behavior and the manual-decompression caveat to the procedure HTTP section.
  • Commit-impact pass: source PR Auto-reconnect (server side only) #5877 added server-side support for SDK auto-reconnect. Existing public docs already keep the lower-level DbConnection reconnection contract unchanged, so no docs change was made for that PR.
  • Compared current skill files in skills/*/SKILL.md against public docs for CLI flows, SDK APIs, server module APIs, auth, onboarding, deployment, MCP, Unity, Unreal, and cross-language casing consistency.
  • The 2026-09-17 skills/docs consistency pass found one high-confidence drift in docs/docs/00200-core-concepts/00200-functions/00400-procedures.md: a TypeScript procedure example declared b as t.u32() while inserting it into a table column declared as t.string().
  • The 2026-09-18 skills/docs consistency pass found no new high-confidence public-doc mismatch. Stale-looking TypeScript reducer syntax appeared only in archived version-1.12.0 docs and was left unchanged.

Validation

  • pnpm build in docs/ passed on 2026-09-17. It emitted the existing Docusaurus update/Browserslist notices and the existing docusaurus-plugin-llms-txt warning for /docs/ask-ai/ask-ai, then generated static files successfully.
  • pnpm --dir docs sync-agent-skills passed on 2026-09-18.
  • pnpm --dir docs typecheck passed on 2026-09-18.

@clockwork-labs-bot clockwork-labs-bot changed the title docs: fix TypeScript table count return type docs: fix daily docs audit drift Sep 16, 2026
</TabItem>
</Tabs>

Procedure HTTP requests automatically accept gzip and Brotli responses and expose the decoded

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Source for this localized docs update: #5698 enabled transparent gzip/Brotli decompression for procedure HTTP requests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant