Skip to content

docs(api): align documentation with v2 API structure and terms#209

Merged
seanbrar merged 1 commit into
mainfrom
docs/align-v2
Jun 16, 2026
Merged

docs(api): align documentation with v2 API structure and terms#209
seanbrar merged 1 commit into
mainfrom
docs/align-v2

Conversation

@seanbrar

@seanbrar seanbrar commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Summary

Aligns the user-facing documentation with the Pollux v2 API architecture and terminology, replacing deprecated parameters (e.g. Options, response_schema, continue_from, continue_tool) with their v2 equivalents (Environment, output, continuation, interact, stream).

Related issue

None

Test plan

Non-behavioral change (documentation updates). Verified that:

  • just lint (Ruff formatting, ruff check, rumdl link checks) runs and passes cleanly.
  • just docs-build (MkDocs compilation) builds successfully without warnings.
  • just typecheck and just test run successfully to confirm no regressions.

Notes

All documentation files have also been audited against internal styling guidelines.


  • PR title follows conventional commits
  • just check passes
  • Tests cover the meaningful cases, not just the happy path
  • Docs updated (if this changes public API or user-facing behavior)

@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@seanbrar seanbrar merged commit 7197eff into main Jun 16, 2026
10 checks passed
@seanbrar seanbrar deleted the docs/align-v2 branch June 16, 2026 10:48
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