Skip to content

Align OpenRath v2.0.0 README and deployment reference - #52

Merged
Tokisakix merged 1 commit into
mainfrom
agent/v2-release-readme
Jul 31, 2026
Merged

Align OpenRath v2.0.0 README and deployment reference#52
Tokisakix merged 1 commit into
mainfrom
agent/v2-release-readme

Conversation

@Tokisakix

Copy link
Copy Markdown
Contributor

Summary

  • preserve the original OpenRath README structure, PyTorch framing, component documentation, workflow example, installation guide, and 12-step learning ladder
  • expand the existing v2.0.0 section around OpenRath's move into production environments: durable Runs, Events, Checkpoints, worker recovery, Effect Ledger, Interrupts, tenant boundaries, PostgreSQL, Redis, artifacts, and operations
  • provide matching English and Simplified Chinese documentation while consistently treating OpenRath as the product name and v2.0.0 as the release version
  • remove the plural examples/ directory by moving the deployable Agent Server application to deploy/reference_app.py
  • update Docker, Compose, Kubernetes, CI, release workflows, and deployment contract tests to use the new reference application path
  • keep the singular example/ directory as the core API learning ladder and link complete scenarios from OpenRath-Example

Why

OpenRath v2.0.0 is primarily the release where OpenRath becomes deployable as a durable production runtime. The README should communicate that change without replacing the project's existing concepts and learning material. The deployable server application also belongs with deployment assets rather than tutorial examples.

Impact

Users retain the familiar README and API introduction while gaining a focused production overview and direct paths to deployment guidance. Deployment manifests and release checks continue to reference the same application after its relocation.

Validation

  • uv run ruff check deploy/reference_app.py tests/deployment/test_reference_manifests.py
  • uv run pytest -q tests/deployment/test_reference_manifests.py tests/deployment/test_release_assets.py ? 7 passed
  • docker compose -f deploy/compose/compose.yaml config --quiet
  • English and Chinese README local-link, code-fence, and Python syntax checks
  • stale repository/path reference scan
  • git diff --check

@Tokisakix
Tokisakix marked this pull request as ready for review July 31, 2026 04:02
@Tokisakix
Tokisakix requested a review from kangkangzi2025 July 31, 2026 04:03
@kangkangzi2025

Copy link
Copy Markdown
Contributor

Merged: OpenRath v2.0.0 documentation now highlights durable production deployment, while the relocated reference application and deployment assets remain fully validated.

@Tokisakix
Tokisakix merged commit 7b3df87 into main Jul 31, 2026
8 of 10 checks passed

@kangkangzi2025 kangkangzi2025 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All required checks passed, approval is complete, and no conflicts remain. Ready to merge.

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