docs: fix inaccurate README examples and comprehensively correct docs#136
Merged
Conversation
README: - Workflow.Compile takes parameters only (it owns its compiler); removed the incorrect compiler argument in the Quick Start and JSON examples. - Rewrote the dependency-chaining example to the real mutation-based pattern (RuleContext is host-side only, not available inside expression strings). docs/ comprehensive review fixes (all verified against source): - Replaced every broken context.GetResult/GetValue/TryGetValue-inside-expression example with the parameter-mutation chaining pattern (rule-action-chaining, examples/index, security, api/rulecontext). - rule-predicates: replaced fictional predicates with the 27 real factory methods. - testing-framework: corrected nonexistent members (Passed/ErrorMessage/ ElapsedMilliseconds/ExpectValueOfType/ExpectNoException/suite.Results), added missing compiler args, fixed expected exception type to InvalidOperationException. - examples/index: LoadFromFile -> LoadWorkflowFromFile, RoslynRules.Extensions -> RoslynRules.Json, result.Data -> result.Value, corrected ValidationErrorType list. - aot-compatibility: removed nonexistent LoadSnapshots/SaveSnapshots and private GetExecutionOrder; use SnapshotManager flow. - api: fixed compiled-delegate, rule-templates, assemblyreferenceprovider (AllowAssembly), exceptions (dropped RuleExecutionException, added AotCompatibilityException), delegate-types (up to 16 params), iruleengine, ruleresult (AllFailures is non-recursive), json-serialization markup. - Reclassified internal CompiledDelegate out of public API tables; qualified the "no DynamicInvoke" claim to single-parameter rules. - Fixed systemic broken links (api back-link ../api-reference.md, dead snapshot and rule-test links, SECURITY.md paths); made compile snippets self-contained. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016biLJMscUzQLmQ25aEhhxt
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.
README:
incorrect compiler argument in the Quick Start and JSON examples.
(RuleContext is host-side only, not available inside expression strings).
docs/ comprehensive review fixes (all verified against source):
example with the parameter-mutation chaining pattern (rule-action-chaining,
examples/index, security, api/rulecontext).
ElapsedMilliseconds/ExpectValueOfType/ExpectNoException/suite.Results), added
missing compiler args, fixed expected exception type to InvalidOperationException.
RoslynRules.Json, result.Data -> result.Value, corrected ValidationErrorType list.
GetExecutionOrder; use SnapshotManager flow.
(AllowAssembly), exceptions (dropped RuleExecutionException, added
AotCompatibilityException), delegate-types (up to 16 params), iruleengine,
ruleresult (AllFailures is non-recursive), json-serialization markup.
"no DynamicInvoke" claim to single-parameter rules.
and rule-test links, SECURITY.md paths); made compile snippets self-contained.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_016biLJMscUzQLmQ25aEhhxt