feat(fast-element): add DESIGN.md for package architecture#7402
Merged
feat(fast-element): add DESIGN.md for package architecture#7402
Conversation
- Add DESIGN.md: comprehensive contributor-oriented architecture guide covering FASTElement, ElementController, Observables, Bindings, html template pipeline, Updates queue, DI, Context, and State helpers. Includes mermaid data flow diagrams and links to detailed ARCHITECTURE_*.md files. - Fix ARCHITECTURE_INTRO.md: correct VIEWTemplate typo to ViewTemplate - Fix ARCHITECTURE_OVERVIEW.md: fix nested double-quotes in mermaid diagram label (style attribute now uses single quotes to avoid parse errors) - Fix ARCHITECTURE_FASTELEMENT.md: correct Compile.compile() to Compiler.compile() - Fix ARCHITECTURE_HTML_TAGGED_TEMPLATE_LITERAL.md: clarify that factory creation happens in static ViewTemplate.create(), and Compiler.compile() is triggered lazily on first render via ViewTemplate.compile() Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
janechu
force-pushed
the
users/janechu/add-design-markdown-fast-element
branch
from
75f2874 to
d55a435
Compare
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
1 participant
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.
Pull Request
📖 Description
Adds a comprehensive
DESIGN.mdtopackages/fast-element/as a single-entry-point architecture guide for contributors. The document covers:htmltagged template literal, ViewTemplate & Compiler, Views & Behaviors, Updates queue, Styles, DI, Context protocol, and State helpersARCHITECTURE_*.mddocuments for deep divesAlso fixes four pre-existing errors in the existing architecture docs:
ARCHITECTURE_INTRO.md: correctedVIEWTemplatetypo →ViewTemplateARCHITECTURE_OVERVIEW.md: fixed nested double-quotes inside Mermaid diagram label (would cause parse errors in some renderers)ARCHITECTURE_FASTELEMENT.md: correctedCompile.compile()→Compiler.compile()ARCHITECTURE_HTML_TAGGED_TEMPLATE_LITERAL.md: clarified that factory creation happens inside the staticViewTemplate.create()call (athtmltag evaluation time) and thatCompiler.compile()is called lazily on first render👩💻 Reviewer Notes
This is a documentation-only change. No source code is modified. The main area for review is the accuracy of the descriptions and diagrams in
DESIGN.mdagainst the actual source code.📑 Test Plan
Documentation-only change. All existing tests continue to pass unchanged.
✅ Checklist
General
$ npm run change