docs: add execution pipeline overview section to README#95
Open
FaikAijaz wants to merge 2 commits intoaccordproject:mainfrom
Open
docs: add execution pipeline overview section to README#95FaikAijaz wants to merge 2 commits intoaccordproject:mainfrom
FaikAijaz wants to merge 2 commits intoaccordproject:mainfrom
Conversation
Signed-off-by: FaikAijaz <faikaijaz635@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR closes issue #94 by adding a new "Execution Pipeline Overview" section to the README, documenting the internal stages of the Template Engine's evaluation process: type validation, TypeScript-to-JavaScript compilation, user code evaluation, AgreementMark generation, and output validation.
Changes:
- Documents the 5-stage execution pipeline of the template engine with accurate descriptions of each step.
- Introduces the
TemplateMarkToJavaScriptCompilerandJavaScriptEvaluatorclasses (including theirevalDangerously()andevalChildProcess()strategies) to the public-facing README. - Adds a summary sentence about the layered architecture's benefits (type-safety, determinism, isolation).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
FaikAijaz
force-pushed
the
faikaijaz/i94/execution-pipeline-docs
branch
from
9a377ec to
1a9b069
Compare
Signed-off-by: FaikAijaz <faikaijaz635@gmail.com>
FaikAijaz
force-pushed
the
faikaijaz/i94/execution-pipeline-docs
branch
from
1a9b069 to
f7d2df0
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
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.
Closes #94
Summary
Adds a new "Execution Pipeline Overview" section to the README to clarify the internal evaluation flow of the Template Engine.
Motivation
While the README explains TemplateMark and AgreementMark at a high level, it does not clearly describe how embedded TypeScript expressions are compiled and evaluated at runtime. This addition improves developer onboarding and clarifies the role of the JavaScriptEvaluator in the execution pipeline.