Skip to content

docs: align SDK guides with current APIs and release boundaries - #93

Merged
guofei66 merged 2 commits into
project-openan:mainfrom
Zhoujie628:main
Oct 13, 2026
Merged

guofei66 merged 2 commits into
project-openan:mainfrom
Zhoujie628:main

Conversation

@Zhoujie628

Copy link
Copy Markdown
Contributor

Closes #92

Changes

  • Reconcile bilingual public API and integration/development guides with actual constructors, transport ownership and optional runtime capabilities.
  • Distinguish the published 0.1.1 artifact from unreleased source capabilities; correct changelog/tag history and remove unsupported release-support claims.
  • Describe Notification-T as result-state-independent: task/result terminal statuses and ACKs do not close the subscription; explicit cancellation, shutdown, stream exit/error or idle timeout ends it.
  • Compile actual bilingual guide snippets against the current public API and check notification lifetime statements.

Validation

  • Full Maven reactor clean verify: 438 tests, no failures, errors or skips; applicable formatting checks, Checkstyle, Javadocs and SpotBugs passed.
  • Public guides' relative links, UTF-8 and code fences checked.
  • Staged diff and sensitive-material scan passed.

Review boundary

Vendor-neutral documentation/test change only; no runtime code, POM version or release publication changed. Common commit is synchronized to dev by cherry-pick, with scenario documentation kept dev-only. No new P1/P2 found in change-specific self-review; real customer/model/platform acceptance is not claimed. Maintainer review and merge requested; no automatic merge.

Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
@Zhoujie628
Zhoujie628 requested a review from a team as a code owner October 13, 2026 08:12
@guofei66
guofei66 merged commit 79ccc5e into project-openan:main Oct 13, 2026
3 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.

docs: align SDK guides with current APIs and release boundaries

2 participants