[AutoDoc] docs: rotisserie batch — audit and fix 4 stale docs#787
[AutoDoc] docs: rotisserie batch — audit and fix 4 stale docs#787penso merged 6 commits intomoltis-org:mainfrom
Conversation
Greptile SummaryThis PR audits and corrects four stale documentation files against the current source, updating Confidence Score: 5/5Safe to merge — documentation-only PR with accurate content; two minor inaccuracies are easy cleanup. All code-level claims were verified against live source: StreamEvent variants, RunnerEvent variants, session_state operation names and return shapes, migration startup sequence, and file paths all match. The only issues are a sessions migration count off by one (8 vs 9) and two stale docs/src/sqlite-migration.md — sessions migration count and two residual server.rs references
|
| Filename | Overview |
|---|---|
| docs/src/session-state.md | Adds delete/clear operations, renames op→operation, and documents return shapes — all verified accurate against crates/tools/src/session_state.rs and crates/sessions/src/state_store.rs. |
| docs/src/slack.md | Adds channel_overrides and user_overrides to the config table with matching TOML examples; changes are straightforward and consistent with existing config patterns. |
| docs/src/sqlite-migration.md | Adds webhooks/vault crates, corrects startup sequence path to prepare_core.rs, expands migration table — but sessions migration count says "+8" when the filesystem has 9 additional files, and two stale server.rs references remain uncorrected. |
| docs/src/streaming.md | Adds ProviderRaw/ReasoningDelta variants (verified in model.rs), corrects runner path to runner/streaming.rs, adds 7 new RunnerEvent→WebSocket mappings (all verified in helpers.rs), and updates example signature to Vec<ChatMessage> (matches trait). |
Sequence Diagram
sequenceDiagram
participant AP as Anthropic API
participant Prov as Provider (anthropic.rs)
participant Runner as AgentRunner (runner/streaming.rs)
participant Chat as ChatService (chat/run_with_tools.rs)
participant WS as Web Crate (moltis-web)
participant UI as Browser
AP->>Prov: SSE stream (content_block_delta, etc.)
Prov->>Runner: StreamEvent (Delta / ToolCallStart / ReasoningDelta / ProviderRaw / Done)
Runner->>Chat: RunnerEvent (TextDelta / ThinkingText / ToolCallStart / ToolCallEnd / ToolCallRejected / SubAgentStart / SubAgentEnd / AutoContinue / RetryingAfterError / LoopInterventionFired / Iteration)
Chat->>WS: JSON frame via WebSocket callback (on_event)
WS->>UI: WebSocket message (delta / thinking_text / tool_call_start / notice / retrying / …)
Comments Outside Diff (1)
-
docs/src/sqlite-migration.md, line 168 (link)Stale
server.rsreference — inconsistent with correction aboveThe Startup Sequence section was updated in this PR to reference
prepare_core.rs, but this line in "Adding Tables to a New Crate" and the DON'T entry on line 285 ("Skip the dependency order in \server.rs`") still sayserver.rs`. Readers following the how-to guide will look in the wrong place.Line 285 also needs updating:
- Skip the dependency order in `prepare_core.rs`
Reviews (1): Last reviewed commit: "[AutoDoc] docs: update streaming — rotis..." | Re-trigger Greptile
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: Christopher L Stewart <100775598+Cstewart-HC@users.noreply.github.com>
All three remaining occurrences in sqlite-migration.md updated.
Doc Rotisserie — Batch 2
Automated audit of 4 stale docs against current source. 105 insertions, 34 deletions.
Changes
session-state.mdop→operationparam fix, added return value docsslack.mdchannel_overrides/user_overridesconfig fieldssqlite-migration.mdstreaming.mdProviderRaw/ReasoningDeltaStreamEvent variants, 7 new RunnerEvent→WebSocket mappings, wrong code paths