Skip to content

docs: add SDK 3 upgrade summaries - #298

Open
zhongkechen wants to merge 1 commit into
mainfrom
docs/sdk-3-upgrade-guides
Open

zhongkechen wants to merge 1 commit into
mainfrom
docs/sdk-3-upgrade-guides

Conversation

@zhongkechen

Copy link
Copy Markdown
Contributor

Developers preparing to move to Core 3 currently need to find the SDK-specific migration documents themselves. Add concise, consistently structured upgrade summaries to the TypeScript, Python, and Java language pages, with direct links from the language-guide landing page.

Each summary covers the coordinated Core/OTel/Testing versions, factory and provider registration changes, layer updates, and replay/concurrency validation. The TypeScript summary preserves the required Testing SDK upgrade order. The Java page distinguishes its existing 2.x plugin contract from 3.x and clarifies provider selection during discovery.

Full migration guides link to verified commit permalinks in the SDK repositories, so the links work while the SDK release PRs remain open. The summaries identify the versions to use after publication. Existing 1.x-to-2.x guidance and its anchors remain available.

Related SDK release documentation: TypeScript #1047, Python #801, and Java #818.

Validation:

  • Zensical 0.0.40 clean site build: no issues found.
  • Full-site Markdown formatting, spelling, and hidden-character checks passed.
  • All 675 example files remain referenced, with no broken includes.
  • Vendored Mermaid and GLightbox integrity checks passed.
  • Generated HTML contains all three upgrade sections, matching subsection titles, valid landing-page anchors, and the full migration-guide links.
  • All three SDK guide permalinks verified through GitHub; package versions and factory APIs checked against SDK source.
  • git diff --check passed.

This adds upgrade summaries and inline API references; complete code examples remain in the linked migration guides.

@zhongkechen
zhongkechen deployed to ai-pr-review-runtime October 22, 2026 22:40 — with GitHub Actions Active

This branch had an error being deployed

1 failed deployment
ai-pr-review-runtime — 132aa4bd Deployed Oct 22, 2026 by zhongkechen via ai-pr-review / Codex review / Generate Codex review #143
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