Skip to content

docs: clarify state/preprocessor guidance for 0.7.8#165

Merged
rlippmann merged 2 commits into
mainfrom
codex/docs-cleanup
May 31, 2026
Merged

docs: clarify state/preprocessor guidance for 0.7.8#165
rlippmann merged 2 commits into
mainfrom
codex/docs-cleanup

Conversation

@rlippmann
Copy link
Copy Markdown
Owner

@rlippmann rlippmann commented May 31, 2026

What changed

  • Clarified state opacity guidance in README.md:
    • engine.state is documented as an opaque authoritative snapshot.
    • normal host reads are directed to get_premise_value(...) and get_policy_items(...).
  • Clarified preprocessor boundary guidance in README.md:
    • pending-clarification bypass (engine.has_pending_clarification() => pass raw input directly to engine.step(...)).
    • explicit false-negative-preferred abstain policy.
  • Added the same pending-clarification bypass note to integration docs where preprocessor flow is described:
    • examples/integrations/litellm/README.md
    • examples/integrations/openwebui/README.md
    • examples/integrations/litellm_proxy/README.md
  • Updated Demo 09 helper usage to public API style without behavior change (get_policy_items(...)).
  • Bumped package version from 0.7.7 to 0.7.8 and updated uv.lock.

Why

  • Keep release docs aligned with intended host usage boundaries (opaque state reads, conservative preprocessing flow, pending-clarification safety).
  • Include release version metadata updates in the same PR for 0.7.8.

Checklist

  • pre-commit run (uv run pre-commit run --all-files)
  • tests pass (uv run pytest)

@rlippmann rlippmann changed the title chore: bump version to 0.7.8 docs: clarify state/preprocessor guidance for 0.7.8 May 31, 2026
@rlippmann rlippmann merged commit 43d40cd into main May 31, 2026
14 checks passed
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.

1 participant