Summary
The current README provides a high-level overview of TemplateMark and AgreementMark, but it does not clearly describe the internal execution pipeline of the Template Engine.
In particular, the flow involving:
- Type validation
- TypeScript compilation
- Runtime evaluation using JavaScriptEvaluator
- AgreementMark generation
is not explicitly documented.
Proposed Improvement
Add a new "Execution Pipeline Overview" section to the README to clarify:
- The internal evaluation stages
- The role of TemplateMarkToJavaScriptCompiler
- The role of JavaScriptEvaluator
- The validation steps before and after generation
This would improve onboarding for contributors and tool developers.
Summary
The current README provides a high-level overview of TemplateMark and AgreementMark, but it does not clearly describe the internal execution pipeline of the Template Engine.
In particular, the flow involving:
is not explicitly documented.
Proposed Improvement
Add a new "Execution Pipeline Overview" section to the README to clarify:
This would improve onboarding for contributors and tool developers.