docs: rules must be wrapped in a workflow that compiles and executes them#138
Merged
Conversation
…them Reframe the README and docs so a Rule is presented as authored on its own but never compiled or executed directly. A Workflow is the container that owns the compiler and drives compilation and execution of its rules. - README: restructure Quick start (define model, author rules, wrap in a workflow, compile and execute the workflow) and convert the multi-parameter example to a workflow. - getting-started: rename steps to author/wrap, fix the stray standalone rule.Compile in the multi-parameter section. - when-to-use-what: drop the 'use Rule, not Workflow' guidance and the standalone Individual Rule section; even a single rule runs in a workflow. - rule.md: add a note that Compile/Execute are the per-rule machinery the workflow invokes; keep the method signatures accurate. - architecture/aot-compatibility/compiled-delegate/security: present Workflow.Compile/Execute as the public entry points. - Convert remaining standalone rule.Compile/rule.Execute snippets across example and API-reference docs to wrap the rule in a workflow. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UAa2aqbD2kKWc71AdHywKC
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.
Reframe the README and docs so a Rule is presented as authored on its own
but never compiled or executed directly. A Workflow is the container that
owns the compiler and drives compilation and execution of its rules.
workflow, compile and execute the workflow) and convert the
multi-parameter example to a workflow.
rule.Compile in the multi-parameter section.
standalone Individual Rule section; even a single rule runs in a workflow.
workflow invokes; keep the method signatures accurate.
Workflow.Compile/Execute as the public entry points.
example and API-reference docs to wrap the rule in a workflow.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01UAa2aqbD2kKWc71AdHywKC