Skip to content

[AutoDoc] docs: rotisserie batch — audit and fix 4 stale docs#787

Merged
penso merged 6 commits intomoltis-org:mainfrom
Cstewart-HC:docs/rotisserie-batch-2
Apr 19, 2026
Merged

[AutoDoc] docs: rotisserie batch — audit and fix 4 stale docs#787
penso merged 6 commits intomoltis-org:mainfrom
Cstewart-HC:docs/rotisserie-batch-2

Conversation

@Cstewart-HC
Copy link
Copy Markdown
Contributor

Doc Rotisserie — Batch 2

Automated audit of 4 stale docs against current source. 105 insertions, 34 deletions.

Changes

Doc Fix
session-state.md 3→5 operations, opoperation param fix, added return value docs
slack.md Missing channel_overrides/user_overrides config fields
sqlite-migration.md Missing webhooks/vault crates, wrong startup sequence path, incomplete table lists
streaming.md Missing ProviderRaw/ReasoningDelta StreamEvent variants, 7 new RunnerEvent→WebSocket mappings, wrong code paths

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 18, 2026

Greptile Summary

This PR audits and corrects four stale documentation files against the current source, updating session-state.md (new delete/clear ops, operation param), slack.md (missing channel_overrides/user_overrides fields), sqlite-migration.md (missing webhooks/vault crates, corrected startup path), and streaming.md (new StreamEvent variants, expanded RunnerEvent→WebSocket table, corrected file paths). All code-level claims were verified against the actual Rust source and match. Two minor inaccuracies remain: the moltis-sessions migration count is off by one, and two stale server.rs references in sqlite-migration.md were not updated alongside the one that was corrected.

Confidence Score: 5/5

Safe 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 server.rs references left behind — both P2 doc accuracy issues that don't affect any runtime behaviour.

docs/src/sqlite-migration.md — sessions migration count and two residual server.rs references

Important Files Changed

Filename Overview
docs/src/session-state.md Adds delete/clear operations, renames opoperation, 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 / …)
Loading

Comments Outside Diff (1)

  1. docs/src/sqlite-migration.md, line 168 (link)

    P2 Stale server.rs reference — inconsistent with correction above

    The 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 say server.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

Comment thread docs/src/sqlite-migration.md Outdated
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.
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