docs: refresh architecture + README for monorepo + dashboard#31
Merged
Conversation
- docs/architecture.md: 'Each file under src/' → 'packages/run/src/'; added a Repository layout section pointing at the packages/run + apps/dashboard split; module map now lists dashboard.ts, ulid.ts, errors.ts (all real now); new Dashboard subsystem detail section. - docs/README.md: new Repository layout section; versioned-guarantees paths corrected (src/config.ts → packages/run/src/config.ts, etc); mentions the dashboard wire shape. - CLAUDE.md: drop the 'legacy dashboard-ui/' line (deleted in PR #28), refresh the 'apps/dashboard/' comment, add ulid.ts and errors.ts to the in-package layout (both exist and are referenced from architecture.md). Docs-only — no behaviour change.
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
2 participants
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.
Docs-only. Brings
docs/architecture.md,docs/README.md, and therepo-layout block in
CLAUDE.mdup to date with the re-monorepo(PR #25) and the dashboard subsystem (PRs #19–#29).
Changes
docs/architecture.mdsrc/" → "Each file underpackages/run/src/".packages/run+apps/dashboardsplit.dashboard.ts,ulid.ts,errors.ts—all real modules today.
read-only DB handle,
/api/*routes, the static-servinguiDirindirection, and the Cloudflare-Worker hand-off.docs/README.mdsrc/config.ts→packages/run/src/config.ts, etc).CLAUDE.mddashboard-ui/" line (deleted in PR feat(dashboard): serve apps/dashboard/dist; remove legacy dashboard-ui/ #28).apps/dashboard/comment (no longer "coming PR feat(dashboard): scaffold apps/dashboard with Vite + Solid + UnoCSS #26").ulid.tsanderrors.tsto the in-package layout (both arereferenced from architecture.md).
Test plan
bun run formatcleanbun run lintcleanGenerated by Claude Code