docs: add stability policy + changelog index, sharpen cluster/wasm scope#181
Merged
Conversation
Add a root CHANGELOG.md that indexes each module's per-module changelog, and a STABILITY.md defining the stability labels used in the README modules table. Link both from the README Status section. There is no single global version (per-module SemVer), so the index makes the release surface discoverable. Sharpen two capability claims to match the code: - the cluster module row now notes the in-memory transport is the tested path, with the gRPC transport module behind the same interface (it is experimental), rather than implying a bundled, finished network layer; - the wasm overview notes that only a Go guest path is exercised today; the JSON ABI is language-agnostic but no non-Go guest SDK ships yet (roadmap #177).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A small, additive documentation-honesty pass.
STABILITY.mddefines every stability label used in the README Modules table (stable / stable-contract / released / advisory / experimental / planned) and what each promises. Graduation criteria + the planned compatibility matrix are deferred to Stabilize the experimental tier toward v1 + publish a compatibility matrix #179.CHANGELOG.md. The repo uses per-module SemVer (no single global version), so this indexes each module's ownCHANGELOG.mdto make the release surface discoverable.README.md) — reworded to match the code: the in-memory transport is the tested path, with the gRPCtransportmodule behind the same interface (it is experimental), rather than implying a bundled, finished network layer.Why
A whole-project review flagged several "honesty" concerns; grounding them against the code showed most were already accurate (e.g.
IMAGE-SLOTmarkers are a documented intentional convention; cluster's gRPC transport is real, in a separate module). What remained were the two wording sharpenings above and the genuinely-missing top-level stability/changelog docs.Verification
go run ./tools/docsgen+astro build→ 87 pages built, with the wasm edit included.CHANGELOG.mdindex links resolve to existing files.