Skip to content

docs: fix inaccurate README examples and comprehensively correct docs#136

Merged
asulwer merged 1 commit into
masterfrom
claude/readme-docs-review-mpczow
Jun 27, 2026
Merged

docs: fix inaccurate README examples and comprehensively correct docs#136
asulwer merged 1 commit into
masterfrom
claude/readme-docs-review-mpczow

Conversation

@asulwer

@asulwer asulwer commented Jun 27, 2026

Copy link
Copy Markdown
Owner

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

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
@asulwer asulwer merged commit c2e5656 into master Jun 27, 2026
2 checks passed
@asulwer asulwer deleted the claude/readme-docs-review-mpczow branch July 5, 2026 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants