docs: fill the README with a real UI-repo overview - #6
Merged
Conversation
The README was still the dunky-dev template-repo boilerplate. Replace it with a real overview of the UI repo: the behavior/render split, the architecture diagram, the packages layout, and the scaffold/develop commands. Also fill the placeholder intro in AGENTS.md and tighten the RECONCILE loop-back note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Why/What
The root README was still the
dunky-dev/template-repoboilerplate (the "What's included" tooling table). This replaces it with a real overview of this repo — the behavior/render split, the architecture diagram, thepackages/layout (core/,dom/,<substrate>/), and the scaffold/develop commands. It also fills the placeholder intro paragraph inAGENTS.md.Verified: every command in the README table maps to a real root script,
pnpm scaffold/pnpm devexist, and the@dunky.dev/<name>package names match the scaffold templates. Thedom/layer described here is already governed by the AGENTS.md Scopes table and Boundaries.Changes
## Layout,## Scaffold,## Develop,## Status.SPEC or TEST→SPEC).Issues
🤖 Generated with Claude Code