Skip to content

docs: document IDC receiver bindings and CLI configuration - #6362

Merged
Shubham8287 merged 4 commits into
shub/idc-uxfrom
docs/idc-receiver-bindings
Oct 24, 2026
Merged

Shubham8287 merged 4 commits into
shub/idc-uxfrom
docs/idc-receiver-bindings

Conversation

@clockwork-labs-bot

@clockwork-labs-bot clockwork-labs-bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Description of Changes

Documentation follow-up to #6313, stacked on shub/idc-ux (source head 9165284be7fc20dd62ec189a893ac0de3e0871a3). Retarget/rebase onto master after the source stack lands; the Based on master gate remains blocked until then.

  • Document client bindings for external applications versus module/receiver bindings for asynchronous inter-database calls.
  • Document receiver dependency configuration, local source/database-target lookup, non-inheritance, receiver build settings, and Rust/TypeScript language/output defaults.
  • Define the calling and receiving databases explicitly, use clients consistently, and replace ambiguous sender terminology.
  • Clarify config-based binding selection: dependencies automatically select module bindings, regular generate entries use the bindings field, and CLI overrides require a single selected generation entry.
  • Preserve the original normal spacetime dev steps; describe receiver generation before the calling-module build, watch paths, and skip flags separately.
  • Update the canonical CLI skill, its packaged copy, and the generated CLI reference. The only Rust source change is neutral wording for generate --bindings help text; it does not implement code generation.

Per Shub's review, this draft describes Rust and TypeScript receiver bindings as implemented and removes the preparation label. The checked source branch still contains placeholder receiver generators. This PR does not supply those implementations, and successful Rust/TypeScript receiver generation or live IDC calls have not been validated. Keep this draft stacked until the corresponding implementations are available.

API and ABI breaking changes

None. Documentation, agent skills, and CLI help wording only; no runtime behavior changes.

Rollback safety impact

n/a

Expected complexity level and risk

2 — focused CLI/configuration documentation and synchronized skill guidance, stacked on an unmerged feature.

Testing

Review validation (the latest wording-only revision reran the production build, skill validation, parity/discovery checks, and diff check; no code or executable snippets changed):

  • Docs typecheck.
  • Docs production build, including link checks.
  • Official CLI-reference generator run twice; output is byte-for-byte reproducible. This compiles the modified CLI help source.
  • All 12 JSON configuration examples parse after removing existing full-line explanatory comments.
  • CLI skill validation, preserving the existing repository-specific triggers extension and validating a temporary copy without it.
  • Plugin parity: all 11 skills match canonical files.
  • Docs discovery: all 11 generated bodies and SHA-256 digests match canonical files.
  • git diff --check.

The initial PR revision also passed five CLI dependency/config/dev tests and one explicit module-option preparation test against the source branch. Those tests cover configuration and placeholder behavior, not working receiver code generation; they were not rerun for this help-text-only source change.

Docs builds emit the existing stale Browserslist and ask-ai Markdown-conversion warnings. Local checks use npm/Node directly because this account cannot execute the host's pnpm installation.

Comment thread codex-plugin/plugins/spacetimedb/skills/cli/SKILL.md Outdated
Comment thread codex-plugin/plugins/spacetimedb/skills/cli/SKILL.md Outdated
Comment thread codex-plugin/plugins/spacetimedb/skills/cli/SKILL.md Outdated
Comment thread docs/docs/00300-resources/00100-cli-reference/00300-spacetime-json.md Outdated
Comment thread docs/docs/00300-resources/00100-cli-reference/00300-spacetime-json.md Outdated
@clockwork-labs-bot clockwork-labs-bot changed the title docs: document IDC receiver binding CLI preparation docs: document IDC receiver bindings and CLI configuration Oct 23, 2026
Comment thread codex-plugin/plugins/spacetimedb/skills/cli/SKILL.md Outdated
Comment thread docs/docs/00300-resources/00100-cli-reference/00300-spacetime-json.md Outdated
@Shubham8287
Shubham8287 marked this pull request as ready for review October 23, 2026 10:10
@Shubham8287
Shubham8287 merged commit bd997ef into shub/idc-ux Oct 24, 2026
69 of 71 checks passed
@Shubham8287
Shubham8287 deleted the docs/idc-receiver-bindings branch October 24, 2026 06:36
@cloutiertyler cloutiertyler mentioned this pull request Oct 30, 2026
5 of 8 tasks
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