Skip to content

Clarify internal execution pipeline in README #94

@FaikAijaz

Description

@FaikAijaz

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions