Skip to content

docs: rewrite reasoning/termination/events/evaluation/state concept pages#30

Merged
fede-kamel merged 3 commits into
mainfrom
docs/concept-rewrites-batch2
May 2, 2026
Merged

docs: rewrite reasoning/termination/events/evaluation/state concept pages#30
fede-kamel merged 3 commits into
mainfrom
docs/concept-rewrites-batch2

Conversation

@fede-kamel
Copy link
Copy Markdown
Contributor

Summary

Second concept-page batch using the same template as PR #29 and the
provider pages: pitch / when to pick / getting started / capabilities
(each runnable) / gotchas / source / see also.

  • reasoning.md (59→141) — lead with the wrong-premise problem, three add-ons each with a runnable snippet, fixed combination order, common gotchas.
  • termination.md (65→139) — lead with the `|` / `&` algebra; runnable predicates; inspect-what-stopped recipe; built-in conditions table; custom conditions; gotchas (operator precedence, `ConfidenceMet` requires `reflexion=True`, etc).
  • events.md (63→191) — reference page covering every `LocusEvent` subtype with the actual fields from `src/locus/core/events.py` (`ThinkEvent.reasoning`, `ToolStartEvent.arguments`, `ReflectEvent.assessment`, `GroundingEvent.score`, …). Multi-agent and causal events documented.
  • evaluation.md (79→139) — align doc with real `EvalCase` API. The previous version showed an `expected={...}` predicate dict that doesn't exist in the framework; replaced with the actual `expected_tools`, `expected_output_contains`, `expected_output_not_contains`, `max_iterations`, `max_duration_ms` fields. Added LLM-as-judge pattern.
  • state.md (61→123) — explain immutable `AgentState` (`tuple` / `frozenset` everywhere, `with_*` builders), `to_checkpoint`/`from_checkpoint` round-trip, reducers for graph branches.

Test plan

  • `hatch -e docs run mkdocs build --strict` — clean (0 warnings, no broken anchors)
  • `pre-commit run --files docs/concepts/{reasoning,termination,events,evaluation,state}.md` — codespell and markdownlint both pass
  • DCO sign-off on the commit

…ages

Same template as the provider pages and the prior concept-page batch:
pitch / when to pick / getting started / capabilities (each runnable) /
gotchas / source / see also.

- reasoning.md: lead with the wrong-premise problem, three add-ons each
  with a runnable snippet, fixed combination order.
- termination.md: lead with the | / & algebra; runnable predicates;
  inspect-what-stopped recipe; built-in conditions table.
- events.md: reference page covering every LocusEvent subtype with the
  actual fields from src/locus/core/events.py.
- evaluation.md: align copy with real EvalCase API
  (expected_tools / expected_output_contains / max_iterations).
- state.md: explain the immutable AgentState, builder methods, and
  reducers for graph branches.

Pages sized 59→141, 65→139, 63→191, 79→139, 61→123.

Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
@oracle-contributor-agreement oracle-contributor-agreement Bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label May 2, 2026
fede-kamel added 2 commits May 2, 2026 10:14
…id fix)

Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
@fede-kamel fede-kamel merged commit 025a652 into main May 2, 2026
10 checks passed
@fede-kamel fede-kamel deleted the docs/concept-rewrites-batch2 branch May 2, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant