-
-
Notifications
You must be signed in to change notification settings - Fork 116
docs: add comprehensive architecture overview with build/runtime stages, package roles, and key terms #484
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.
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
docs: add comprehensive architecture overview with build/runtime stages, package roles, and key terms #484
Conversation
|
|
…build/runtime stages Co-authored-by: jankapunkt <1135285+jankapunkt@users.noreply.github.com>
|
@copilot extend the file with another section that explains the most important Terms within the Blaze ecosystem:
|
…Instance, and View Co-authored-by: jankapunkt <1135285+jankapunkt@users.noreply.github.com>
I've added a comprehensive "Key Terms in the Blaze Ecosystem" section to OVERVIEW.md covering: Spacebars - The template language with mustache-style syntax, block helpers, and reactive expressions. Includes code examples showing conditionals, iteration, and template inclusion. Template - Reusable components defining structure and behavior. Explains definition in .html files, JavaScript API, helpers, event handlers, and lifecycle hooks with practical examples. Template Instance - Specific instantiation of a template with its own state and lifecycle. Covers instance-specific state, view reference, data context, DOM access, and subscription management with usage examples. View - The low-level primitive for reactive rendering. Explains render functions, parent-child hierarchy, lifecycle phases, DOM tracking, and relationship to Templates. Also added a visual diagram showing the relationship: Template → Template Instance → View → HTMLjs → DOM Commit: 4d0074a |
…eferences View Co-authored-by: jankapunkt <1135285+jankapunkt@users.noreply.github.com>
ff73c64
into
docs/improve-architecture-overview
|
This kind of summarization is very useful, especially if we expand or integrate Blaze more closely with other tools. It helps to know each architecture item, its purpose, and expectations. It’s also great to see AI can help us maintain this over time. |
Adds detailed architecture documentation to
OVERVIEW.mdexplaining how Blaze packages interact during build and runtime phases. This addresses #482.Changes
High-level architecture
Build vs. Runtime stages
Package documentation
blaze,templating-runtime,spacebars,htmljs,observe-sequencetemplating-compiler,spacebars-compiler,html-tools,templating-tools,caching-html-compilertemplating,blaze-html-templatesui,blaze-toolsEach package entry includes:
Data flow diagrams
.html→ compiler chain → JavaScript outputKey Terms section
.htmlfiles, JavaScript API, helpers, event handlers, and lifecycle hooks with working examples.Key architectural benefits
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.