Skip to content

docs: drop the duplicated SubstrateKind bullet and correct substrate comments - #657

Merged
ac-pplx merged 1 commit into
mainfrom
ac/substrate-docs-followups
Oct 19, 2026
Merged

ac-pplx merged 1 commit into
mainfrom
ac/substrate-docs-followups

Conversation

@ac-pplx

@ac-pplx ac-pplx commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Docs and comments only; no code or behaviour change.

  • Duplicate bullet. Bind the last substrate literals and forbid new ones with archcheck #611 and Ask SubstrateKind row-level questions instead of matching the substrate #602 each added the same row-decision bullet under "Substrate values are bound parameters" in docs/rust/space-conventions.md, and both merged textually, so the bullet appeared twice. This keeps the copy with the examples (proves_execution_absence, REGISTRY_SUBSTRATE).
  • SubstrateKind::wakes_after_failed_control_connect (common/core/src/types/node.rs): the Space bullet said Direct wakes "a dormant sandbox" on the access path, but the Kubernetes bullet above defines dormant as "suspended, or created and never started", and DirectSubstrate::access_runtime_client wakes only Suspended | Restoring rows. It now says "a suspended or restoring sandbox".
  • REGISTRY_SUBSTRATE (routes/admin/node_maintenance.rs): "every registry statement scopes to it" overstated it; fetch_node/fetch_nodes read nodes of every substrate. It now says every registry write to nodes/node_direct binds it and verify proceeds only for a live node of it, while the reads and the template pull and delete routes (node_maintenance/node_templates.rs, which load the node with fetch_node) act on nodes of every substrate. The registry's substrate_scope test module header ("reads and writes only Direct nodes") now describes what the module tests: writes and verify.

The last two were raised in review on #602 after it was approved.

Validation: documentation and comment changes only, so no workspace checks per the repository's validation rules; the pre-commit hook passed.

🤖 Generated with Claude Code

@ac-pplx
ac-pplx force-pushed the ac/substrate-docs-followups branch from 88bec5c to c7e6750 Compare October 19, 2026 21:19
…comments

#611 and #602 each added the same row-decision bullet to
docs/rust/space-conventions.md, so it appeared twice; keep the copy with
the examples.

Correct comments #602 added:
- `wakes_after_failed_control_connect`: Direct's access path wakes a
  suspended or restoring sandbox (`DirectSubstrate::access_runtime_client`),
  not every "dormant" sandbox as the Kubernetes bullet defines it.
- `REGISTRY_SUBSTRATE`: every registry write to `nodes`/`node_direct` binds
  it and `verify` proceeds only for a live node of it; the registry's reads,
  and the template pull and delete routes, act on nodes of every substrate.
- The registry's `substrate_scope` test module header, which said the
  registry reads only Direct nodes, now describes what it tests: writes and
  `verify`.
@ac-pplx
ac-pplx force-pushed the ac/substrate-docs-followups branch from c7e6750 to ac104da Compare October 19, 2026 21:20
@ac-pplx
ac-pplx marked this pull request as ready for review October 19, 2026 21:45
@ac-pplx ac-pplx changed the title docs: drop the duplicated SubstrateKind bullet and correct two substrate comments docs: drop the duplicated SubstrateKind bullet and correct substrate comments Oct 19, 2026
@ac-pplx
ac-pplx added this pull request to the merge queue Oct 19, 2026
Merged via the queue into main with commit 7e01307 Oct 19, 2026
20 checks passed
@ac-pplx
ac-pplx deleted the ac/substrate-docs-followups branch October 19, 2026 23:44
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