Skip to content

[Mirror PR #3243] docs: append quick-reference directory map to ARCHITECTURE.md #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tmdeveloper007 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Mirror PR #3243] docs: append quick-reference directory map to ARCHITECTURE.md #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,13 @@ Use these rules when deciding where a change belongs:
* Third-party integrations belong in `adapters`.

When in doubt, prefer the lowest-level package that owns the responsibility and avoid moving functionality across package boundaries without a documented reason.


---

## ⚡ Quick Directory Map
* `packages/core/` — Primary engine runtime, buffer loops, cell grids, and terminal inputs.
* `packages/widgets/` — Visible interface layout modules (Boxes, Tables, Gauges).
* `packages/ui/` — Highly interactive overlay controls, compound prompt boxes, and Modals.
* `packages/jsx/` — Custom TypeScript compilation runtimes and core hooks handlers.
* `packages/testing/` — Custom headless mock-rendering blocks for continuous validation.