Skip to content

docs: fix generate usage for Unreal bindings#5175

Closed
clockwork-labs-bot wants to merge 1 commit into
masterfrom
bot/docs-generate-unreal-usage-20260602
Closed

docs: fix generate usage for Unreal bindings#5175
clockwork-labs-bot wants to merge 1 commit into
masterfrom
bot/docs-generate-unreal-usage-20260602

Conversation

@clockwork-labs-bot
Copy link
Copy Markdown
Contributor

Summary

  • Fix the spacetime generate usage string so Unreal-specific flags are no longer shown as mutually exclusive with module source flags.
  • Update the current CLI reference to match the corrected usage.

Audit context

Daily skills/docs consistency audit found this mismatch between skills/unreal/SKILL.md, skills/cli/SKILL.md, and the public CLI reference: Unreal generation uses --uproject-dir and --unreal-module-name together, often with a module source flag, but the docs usage line grouped those flags as alternatives.

Validation

  • git diff --check
  • corepack pnpm -C docs typecheck
  • corepack pnpm -C docs build

Note: cargo/rustup are not installed in this runtime, so I could not run Rust formatting or CLI tests locally.

@clockwork-labs-bot
Copy link
Copy Markdown
Contributor Author

Consolidated this into #5166 so the docs audit fixes stay in one reviewable PR.

pull Bot pushed a commit to Mu-L/SpacetimeDB that referenced this pull request Jun 5, 2026
## Summary

Consolidates the outstanding docs PRs opened by `clockwork-labs-bot` /
Docs Gremlin into one reviewable PR:

- clockworklabs#4958
- clockworklabs#5085
- clockworklabs#5089
- clockworklabs#5097
- clockworklabs#5112
- clockworklabs#5114
- clockworklabs#5117
- clockworklabs#5127
- clockworklabs#5138
- clockworklabs#5165
- clockworklabs#5175
- clockworklabs#5222

This combines docs updates for:

- getting-started links
- server-issued auth token reconnect behavior in the Unity tutorial
- C++ module/client language coverage
- Unreal client ticking / `FrameTick` guidance
- C# connection callback signatures and codegen language spelling
- deterministic schedule-table sample time
- client frame ticking troubleshooting
- corrected `spacetime generate` usage for Unreal bindings
- TypeScript framework integration reference updates for SolidJS and
current React query-builder tuple usage

## Validation

- `rg -n '^(<<<<<<<|=======|>>>>>>>)' docs crates skills`
- `git diff --check origin/master...HEAD`
- `pnpm --dir docs typecheck`
- `pnpm --dir docs build`

---------

Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
Co-authored-by: rain <rain@rain.local>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
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