Skip to content

docs(readme): describe block data binding#112

Merged
flyingrobots merged 1 commit into
mainfrom
docs/readme-block-binding-system
May 23, 2026
Merged

docs(readme): describe block data binding#112
flyingrobots merged 1 commit into
mainfrom
docs/readme-block-binding-system

Conversation

@flyingrobots
Copy link
Copy Markdown
Owner

@flyingrobots flyingrobots commented May 23, 2026

Summary

  • adds a README subsection for the unidirectional binding loop behind Blocks
  • explains providers/business logic -> immutable snapshots -> BindingFrame -> block/view render -> CommandIntent -> business logic
  • clarifies that public contracts live in @flyingrobots/bijou while runtime lifecycle and host integration stay in the TUI layer
  • links the DX-034 declarative view data binding design

Validation

  • git diff --check
  • npm run docs:inventory
  • npm test -- --run tests/cycles/WF-006/cut-clean-4-1-0-release-boundary.test.ts tests/cycles/DF-025/make-dogfood-the-only-human-facing-docs-surface.test.ts scripts/docs-preview.test.ts
  • pre-commit: npm run lint
  • pre-push: npm run typecheck:test
  • pre-push: npm test (310 files, 3491 tests)
  • pre-push: npm run verify:interactive-examples

Summary by CodeRabbit

  • Documentation
    • Added detailed documentation on the unidirectional binding architecture and design constraints, including references to public contracts and architecture documentation.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8c35a12c-0d8f-462e-9a0e-4d6e175289bf

📥 Commits

Reviewing files that changed from the base of the PR and between 7618396 and a64a4a3.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR adds a "Unidirectional Binding" section to the README documenting Blocks' one-way declarative binding loop. The new content explains the data flow from provider snapshots through view rendering to command intents, clarifies contract boundaries, and references the public API and design documentation.

Changes

Documentation

Layer / File(s) Summary
Unidirectional Binding documentation
README.md
New "Unidirectional Binding" subsection explains Blocks' one-way binding contract: provider snapshots flow to binding frame render input, views render without mutable stores or two-way binding, and only command intents return to business logic. References @flyingrobots/bijou contracts and the declarative view data binding design document.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • flyingrobots/bijou#91: The main PR's README "Unidirectional Binding" contract (provider snapshots → binding frame render input → one-way view rendering → intent-only Commands) directly aligns with—and documents the same declarative unidirectional binding model—covered by the retrieved PR's DX-034D "active binding lifecycle" design/test.
  • flyingrobots/bijou#88: The main PR's new "Unidirectional Binding" README section directly aligns with the retrieved PR's DX-034 "declarative view data binding" documentation (same unidirectional binding loop concepts between snapshots, view rendering, and command intents).

Poem

🐰 A rabbit's ode to unidirectional flow,
Where snapshots dance and bindings glow,
No circles back, no two-way dance,
Just provider → render → intent's advance,
The README speaks the binding's way! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation about block data binding to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-block-binding-system

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@flyingrobots flyingrobots merged commit b4e31a5 into main May 23, 2026
7 checks passed
@flyingrobots flyingrobots deleted the docs/readme-block-binding-system branch May 23, 2026 21:21
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