Skip to content

docs: doc refinements#50

Closed
ivanbanov wants to merge 1 commit into
mainfrom
md-tweaks
Closed

docs: doc refinements#50
ivanbanov wants to merge 1 commit into
mainfrom
md-tweaks

Conversation

@ivanbanov

Copy link
Copy Markdown
Member

Why/What

Bringing across the genuinely portable doc refinements that surfaced while working the shared state-machine docs in another worktree. dunky is the source of truth for these files, so most of that work was either substrate-specific or already present here — this PR is only the two deltas that actually improve dunky.

Changes

  • AGENTS.md — Comments rule: don't restate a rule already in ARCHITECTURE.md; that duplication just drifts out of date.
  • ARCHITECTURE.md — give the createStore paragraph its own Cross-instance state subsection, parallel to Two homes for a side-effect under The machine parts (better structure/TOC).

Docs-only, no published-package change, so no changeset.

Considered but not ported

  • Substrate-specific rules (Stitches logic/styles split, tokens, Radix track, jest-axe, className/asChild, nvm) — don't apply to this engine repo.
  • SPEC/README trims from the other copy (dropped "problem it solves" paragraph, dropped ARCHITECTURE "Vocabulary" table) — dunky's fuller versions are kept.
  • A |_ file-tree diagram convention — skipped: dunky's diagrams consistently use +--, and adopting |_ half-way would contradict existing trees (the source repo doesn't follow it either). Happy to do a full sweep if we want that style.

Issues

🤖 Generated with Claude Code

- AGENTS.md: comments must not restate a rule already in ARCHITECTURE.md
  (that duplication drifts out of date).
- ARCHITECTURE.md: give the createStore paragraph its own
  "Cross-instance state" subsection, parallel to "Two homes for a
  side-effect" under "The machine parts".

Both are refinements that surfaced while working the shared docs
elsewhere; the rest of that work is either substrate-specific or already
present here.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dunky-state-machine Ready Ready Preview, Comment Jul 17, 2026 5:55pm

@ivanbanov ivanbanov changed the title docs: port doc refinements from the dialog worktree docs: doc refinements Jul 17, 2026
@ivanbanov ivanbanov closed this Jul 17, 2026
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