Skip to content

docs: fix daily docs audit findings - #5516

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

docs: fix daily docs audit findings#5516
clockwork-labs-bot wants to merge 34 commits into
masterfrom
bot/docs-audit

Conversation

@clockwork-labs-bot

@clockwork-labs-bot clockwork-labs-bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Keep scripted --delete-data examples explicit while leaving interactive examples concise.
  • Clarify generated C# reducer result callbacks, including the chat tutorial wording for conn.Reducers.On... events.
  • Update C# reducer examples to use generated PascalCase method/event names.
  • Align scheduled-function docs with the TypeScript/C# skill guidance: TypeScript scheduled callbacks use (): any => ..., TypeScript scheduled table fields use snake_case in snake_case tables, and the C# scheduled-table example names ScheduledAt explicitly.
  • Update current Rust and C++ docs snippets to use the 2.x sender APIs (ctx.sender() / ctx.sender()) and the current Rust spacetimedb::Identity import.

Validation

  • git diff --check
  • pnpm --dir docs typecheck

@clockwork-labs-bot clockwork-labs-bot changed the title docs: update delete-data flag examples docs: fix daily docs audit findings Jul 11, 2026
Comment thread docs/docs/00100-intro/00100-getting-started/00400-key-architecture.md Outdated
Comment thread docs/docs/00200-core-concepts/00100-databases/00300-spacetime-publish.md Outdated
Comment thread docs/docs/00200-core-concepts/00300-tables/00210-file-storage.md
Comment thread docs/docs/00300-resources/00100-how-to/00600-migrating-to-2.0.md

```typescript
const damageEvent = table({
const damage_event = table({

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No snake_case in TypeScript.

- `--server`: target server
- `--break-clients`: allow breaking changes
- `--delete-data`: clear database data
- `--delete-data=<mode>`: clear database data (`always`, `on-conflict`, or `never`)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this a generated file?

@clockwork-labs-bot

Copy link
Copy Markdown
Contributor Author

Daily docs/skills consistency audit for 2026-07-29:

  • Merged current origin/master into bot/docs-audit per the daily audit branch rule.
  • Commit-impact pass checked changes since the previous docs-audit baseline (8ecd3c3ba..origin/master):
    • 3409eacc1 fixes TypeScript composite btree range scans. Public index docs already describe prefix scans and trailing-column Range filters for TypeScript multi-column indexes, so no public docs change was needed.
    • 851348938 moves metrics utilities internally; no public docs or skill impact found.
  • Re-synced agent skill static assets; no generated diff.
  • Compared skill coverage against public docs for CLI flows, SDK APIs, server module APIs, auth/onboarding/deployment, and cross-language consistency. No additional high-confidence mismatch found today.

Validation:

  • pnpm --dir docs sync-agent-skills
  • pnpm --dir docs build

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.

2 participants