Skip to content

Add spacetime.json documentation page#4504

Open
cloutiertyler wants to merge 2 commits intomasterfrom
tyler/spacetime-json-docs
Open

Add spacetime.json documentation page#4504
cloutiertyler wants to merge 2 commits intomasterfrom
tyler/spacetime-json-docs

Conversation

@cloutiertyler
Copy link
Contributor

Summary

  • Adds a new reference documentation page for the spacetime.json configuration file, based on proposal 0032
  • Page covers config structure, field reference, generate configuration, children/inheritance, spacetime dev config, database selection, flag overrides, --no-config, --env and environments, config file discovery, and editor support
  • Follows STYLE.md conventions: reference page tone, declarative present tense, active voice

Test plan

  • docusaurus build succeeds
  • Page appears in sidebar under CLI Reference at /cli-reference/spacetime-json
  • Review content accuracy against proposal 0032
  • Verify internal links resolve correctly

Reference docs for the spacetime.json config file (proposal 0032),
covering config structure, field reference, generate configuration,
children/inheritance, dev configuration, database selection, flag
overrides, environments, config discovery, and editor support.
Docs fixes:
- Use game-world region names instead of cloud regions (region-us etc.)
- Replace "testnet" server with "maincloud"
- Fix config precedence order to match Vite's convention
- Fix spacetime dev step ordering (build, generate, publish)
- Fix config auto-generation description (spacetime.json + spacetime.local.json)
- Fix safety prompt description (only spacetime.json triggers it)
- Move --build-options from global to per-database overrides

Code fixes:
- Stop inheriting generate from parent to children, preventing
  different modules from silently overwriting each other's bindings
- Implement source conflict rule: if a child specifies any of
  module-path/bin-path/js-path, the others are not inherited
- Mark --num-replicas as module_specific (per-database override)
- Update tests to match new generate inheritance behavior
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