Skip to content

docs: fix CLI and TypeScript docs examples#5429

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

docs: fix CLI and TypeScript docs examples#5429
clockwork-labs-bot wants to merge 33 commits into
masterfrom
bot/docs-audit

Conversation

@clockwork-labs-bot

@clockwork-labs-bot clockwork-labs-bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • correct reset examples to pass an explicit --delete-data always mode
  • replace the stale --lang ts shorthand with the supported typescript generator language
  • apply the same corrections to the versioned docs copy
  • use snake_case table names in the TypeScript shared-table example so it matches current table/accessor guidance
  • fix the current TypeScript logging example to import schema and t, matching the server SDK API exposed from spacetimedb/server

Validation

  • pnpm --dir docs build

Daily SpacetimeDB skills/docs consistency audit. PR #5166 / docs/consolidated-docs-prs is merged, so this run updated the existing open daily docs audit PR on bot/docs-audit.

@clockwork-labs-bot clockwork-labs-bot changed the title docs: fix CLI reset and TypeScript codegen examples docs: fix CLI and TypeScript docs examples Jun 26, 2026
@clockwork-labs-bot

Copy link
Copy Markdown
Contributor Author

Daily skills/docs consistency audit update (2026-06-27):

  • Merged current origin/master into bot/docs-audit.
  • Checked skills against current public docs for CLI flows, TypeScript client reducer calls, server module APIs, scheduling, auth, and deployment-facing references.
  • Fixed one high-confidence mismatch in the TypeScript client reference: the SolidJS useReducer example now uses the generated named-argument object form, matching TypeScript codegen and adjacent docs examples.
  • Validation: pnpm build in docs/ passed. Docusaurus emitted an existing llms-txt warning for /docs/ask-ai/ask-ai, but the build exited 0.

@clockwork-labs-bot

Copy link
Copy Markdown
Contributor Author

Daily skills/docs consistency audit update (2026-06-30): merged current origin/master into bot/docs-audit and added a narrow consistency fix to skills/concepts/SKILL.md so the concepts skill no longer describes TypeScript modules as WebAssembly bundles. Validation: pnpm build in docs passed; cargo run -p spacetimedb-cli -- generate --help passed; agent skill sync check passed.

@clockwork-labs-bot

Copy link
Copy Markdown
Contributor Author

Daily skills/docs consistency audit run for 2026-07-04.

  • Confirmed PR docs: consolidate outstanding docs fixes #5166 / docs/consolidated-docs-prs is merged and no open consolidated PR exists.
  • Used existing open daily audit PR docs: fix CLI and TypeScript docs examples #5429 on bot/docs-audit; no new branch/PR was created.
  • Merged current origin/master into bot/docs-audit and pushed the branch update.
  • Compared the public skills/*/SKILL.md files against public docs for CLI flows, SDK APIs, server module APIs, auth, onboarding, deployment, and cross-language consistency.
  • No additional high-confidence public docs mismatch was found in this run.

Validation:

  • pnpm --dir docs build passed. Existing warnings: stale browsers data and the llms-txt Ask AI route conversion warning.

@clockwork-labs-bot

Copy link
Copy Markdown
Contributor Author

Daily skills/docs consistency audit update (2026-07-05):

  • Merged current origin/master into bot/docs-audit.
  • Fixed Rust view examples that still used the old #[spacetimedb::table(name = ...)] form instead of accessor = ... .
  • Aligned cheat sheet CLI quick commands with current describe --json and explicit generate --out-dir/--module-path usage.
  • Validation: pnpm build from docs/ succeeded. Existing docusaurus-plugin-llms-txt warning for /docs/ask-ai/ask-ai was emitted, but build completed successfully.

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