docs: explain workflows and terminology - #113
Merged
Merged
Conversation
This was referenced Sep 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Developers had no public map connecting the CLI, library and agent skill to the conversion and registered-block workflows. Similar names also hid different contracts. Closes #110.
Solution
Add a source-linked architecture guide covering inputs, outputs, shared finalisation, generated-block delivery and the existing terminology. Builds on the custom-rule example in #112; the diff contains only the architecture guide.
realizeandassembleDiff
+95 −0 · 1 file · no runtime or API changes
Testing & verification
Reviewed revision:
3c4694a56e3fe269b243aea3e09b2f4f74d2b36c· Environment: macOS, source inspection against the 0.9.7 code.python3 /tmp/block-runner-docs-pass/check-links.py . docs/architecture.md docs/extending.md— passed, 36 candidate repository paths/anchors and zero failures. This was a local review utility, not a new repository dependency.npm run check:private— passed. The new guide was separately reviewed becausedocs/is outside the packed-file scan.git diff --cached --check— passed before commit.Not verified: human onboarding acceptance. This is a documentation/source review, not new WordPress runtime or visual proof. GitHub CI passed on this revision: all three Node lanes, package-boundary, WordPress proof and the aggregate CI scope check. Run 34981865592.
Risk / rollout
Source links or diagrams can drift as implementation changes. The guide links entry points and identifies the different assembly and write boundaries without renaming them. The website, skill instructions and runtime remain unchanged.
Detection: follow the named callers when changing those workflows. Rollback: revert this guide commit. Merge after #112; the README entry link follows in the final documentation PR.
Authored by: GPT-6 via Codex.