Generated API Reference
SDK Javadoc generation, review, and publication status.
The SDK Javadoc is generated from the matching Turboism source tree and hosted under the SDK documentation site only after review.
Documentation update workflow
When the public SDK, its documentation, or its version changes:
- generate Javadoc with the source repository's
:sdk:javadocGradle task; - verify the exact version and reject snapshot output;
- review every publicly searchable package and type;
- confirm that internal implementation types and unapproved Preview APIs are not presented as public contracts;
- check generated text for private data, local paths, credentials, host logs, or implementation-only evidence;
- synchronize the reviewed output to the documentation site; and
- run the documentation lint, type check, and production build.
Successful generation alone does not approve publication. If the generated public surface or version is not ready, keep the hosted Javadoc unchanged and record the blocker here.
Current status
The 0.43.3 release-mode candidate has been generated and reviewed. Its version is correct and does not contain a snapshot marker, but it was not synchronized because:
ActiveReadProjectionsremains publicly searchable while its own documentation says that it is an internal helper outside the stable plugin API;- the generated constant-values page contains a broken local anchor; and
- several public types still use Preview API language and need an approved public-reference policy.
The update script now detects the version automatically, scans generated output for blocked material and broken local links, requires explicit approval for Preview API language, and validates the documentation site after synchronization.
Until those blockers are resolved, use the SDK API Guide and the public SDK source declarations. Do not rely on the currently hosted HTML reference for release, deployment, or compatibility claims.