Skip to content

docs: finalize durable steering documentation sync - #18

Merged
leecyang merged 12 commits into
mainfrom
docs/issue-16-steering-final-sync
Aug 18, 2026
Merged

leecyang merged 12 commits into
mainfrom
docs/issue-16-steering-final-sync

Conversation

@leecyang

Copy link
Copy Markdown
Collaborator

Summary

Follow-up docs-only cleanup after #17. This PR aligns the public documentation with the final merged durable-steering semantics.

Fixed

  • add POST /v1/runs/{run_id}/steer to the zh/en API overview endpoint lists
  • correct the Run lifecycle diagram so resume creates a new pending descendant instead of implying the old paused Run becomes pending
  • move sync/async SDK steering examples before terminal completion, so they no longer demonstrate an impossible post-join steer
  • align docs/api.md with the final protocol:
    • terminal-only steering_closed finalization gate
    • fenced commit_steering_consumptions_if_owned() name
    • run.steer.superseded lifecycle and unconsumed_at_final_boundary
    • typed superseded_by_run_id lineage and stale-run cancel behavior
  • correct payload_too_large to HTTP 413 everywhere in the steering API docs
  • remove review-round archaeology from the public operations pages and replace it with stable product/runtime rationale
  • clarify zh/en operations docs that paused outcomes never close steering admission
  • expand Documentation workflow path filters so docs/**, README files, and CHANGELOG changes trigger docs CI

Scope

Documentation and documentation CI only; no Runtime/Server behavior changes.

@mintlify

mintlify Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lingxi-0d63865e 🔴 Failed – Aug 18, 2026, 11:13 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@leecyang leecyang left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Final review: no blocking issues found. The docs-only follow-up correctly aligns the zh/en API overview, SDK examples, steering status/error semantics, finalization/lineage documentation, and docs CI path coverage with the merged #17 implementation. Documentation check/typecheck/build and the full PR CI are green. Ready to merge.

@leecyang
leecyang merged commit 509b4f0 into main Aug 18, 2026
12 of 13 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