Clarify architecture boundaries and public API - #5
Open
turinglambdaai wants to merge 101 commits into
Open
turinglambdaai wants to merge 101 commits into
turinglambdaai wants to merge 101 commits into
Conversation
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
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.
Summary
This PR performs a low-risk architecture/documentation cleanup without changing existing public bindings or moving native backend files.
What changed
docs/architecture.mdwith current layers, dependency rules, and Public/Internal/Platform-specific boundariesROADMAP.mdglaze/main.rktas the compatibility-preserving public facade; exports are unchangedglaze-test/public-api-test.rktto protect(require glaze)and basic facade behaviorexamples/tray/andexamples/events/examples using only the public facadeCompatibility
No public API was removed or renamed. Existing focused module imports remain supported. Platform backend files were not moved.
Why
The repository already has a good dispatcher/backend shape for WebView, tray, and sys. The higher-value stabilization step is to make that boundary explicit and test the facade before considering any directory migration or larger runtime abstraction.
Validation
The existing CI matrix runs
raco test glaze-test/on Windows, macOS, and Linux, plus native WebView e2e and package builds. The new facade test is included automatically by the existing directory test command.