Skip to content

docs: redraw the layer diagrams and document the agnostic core utils - #62

Merged
ivanbanov merged 3 commits into
mainfrom
readme-diagram-fix
Nov 16, 2026
Merged

ivanbanov merged 3 commits into
mainfrom
readme-diagram-fix

Conversation

@ivanbanov

@ivanbanov ivanbanov commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Brings the README, ARCHITECTURE, and AGENTS docs in line with the repo.

README

  • Redraws the layer diagram as three layers: agnostic (core/<name> + generic utilities), platform (dom, native), and substrates (glue code, thin connectors to each host).
  • Adds a core/utils/ entry to the Layout list.
  • States the layer order core first: core -> dom -> substrate.

ARCHITECTURE

  • Redraws the layers diagram with the agnostic utils, the DOM layer (components + utils), substrate hooks, and native's direct path from core to substrate.
  • Describes core/utils/ as agnostic utilities (controllable and the overlay stack), not only machine logic.
  • Fixes the import rules: a core package also imports the agnostic utils, and a DOM util may import the agnostic util it extends for the DOM.

AGENTS

  • Same DOM util import rule fix.

Docs only, so no changeset.

🤖 Generated with Claude Code

ivanbanov and others added 2 commits November 16, 2026 11:18
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…layers

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ivanbanov ivanbanov changed the title docs: center the README diagram and show every DOM host docs: redraw the README diagram as agnostic, platform, and substrate layers Nov 16, 2026
The core and DOM util import rules missed real edges: core/dialog imports
controllable, and dom-overlay builds on the agnostic overlay stack. The
layers diagram now shows the core utils and the DOM layer, and native's
direct path from core to substrate.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ivanbanov ivanbanov changed the title docs: redraw the README diagram as agnostic, platform, and substrate layers docs: redraw the layer diagrams and document the agnostic core utils Nov 16, 2026
@ivanbanov
ivanbanov merged commit ec2645e into main Nov 16, 2026
6 checks passed
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