Skip to content

Verify release packaging and document the current SDK API - #153

Merged
Stephen Belanger (Qard) merged 1 commit into
refactor/release-msrv-resolutionfrom
refactor/release-package-docs
Oct 28, 2026
Merged

Stephen Belanger (Qard) merged 1 commit into
refactor/release-msrv-resolutionfrom
refactor/release-package-docs

Conversation

@Qard

Copy link
Copy Markdown
Contributor

The README still showed removed constructors and an async-only API, and the crate archive included repository hooks and CI tooling. Make the README the crate-level documentation so its Rust examples compile as doctests, and document the current client, eager completions, span lifecycle, runtime selection and evaluation APIs. Installation explicitly points to a checkout while this API remains unreleased.

Declare package contents explicitly, retaining sources, tests, examples, README, license and logo. Add cargo package --locked to the Rust 1.86 CI job to verify the distributable artifact before release.

Validation: stable and Rust 1.86 doctests passed (19 passed, four existing ignored). Rust 1.86 fresh offline resolution, package creation/verification, and doctests plus example checks from the unpacked archive passed. Strict Clippy, rustdoc, formatting and diff checks passed. Archive inventory assertions confirm repository tooling and local planning documents are excluded. No publication or version change.

Stacked on #152; this is the packaging/documentation portion of release preparation (stage 9).

@Qard
Stephen Belanger (Qard) merged commit d52df1a into refactor/release-msrv-resolution Oct 28, 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.

1 participant