docs: mark experimental surface + API-stability contract#125
Merged
Conversation
Pre-1.0 two-tier message (council 1.0 cut-line): tag the young/unstable surface EXPERIMENTAL in godoc and write down the stability contract so 1.0 freezes a minimal core while keeping the rest evolvable. EXPERIMENTAL markers: WithBackplane + the Backplane interface (distributed path pre-GA; no distributed-GA promise at 1.0), Broadcast/BroadcastNotify/ BroadcastSignals (cross-pod), the Plugin interface (+ bundled plugins), Ctx.Notify (toast surface, not the contract), Signal.TextSpan/ShowUnless and LocalSignal.ShowUnless, and the diagnostic knobs WithStrictDecode/ WithVerboseErrors/WithoutDevChecks. New docs/stability.md (linked from Reference & ops): the stable core vs experimental tiers, and — because via binds state by struct field and routes actions by method name — what counts as a breaking change (exported field names/order + via tags, and root method names) and that the URL route is the in-place evolution seam.
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.
Council 1.0 cut-line #5: the pre-1.0 two-tier message.
Change (docs/comments only — no behavior)
WithBackplane+ theBackplaneinterface (distributed path pre-GA; 1.0 promises no distributed GA), theBroadcast*family (cross-pod), thePlugininterface + bundled plugins,Ctx.Notify(the toast surface, not its contract),Signal.TextSpan/ShowUnless+LocalSignal.ShowUnless, and the diagnostic knobsWithStrictDecode/WithVerboseErrors/WithoutDevChecks. Markers are trailing paragraphs so synopses stay clean.docs/stability.md(linked from Reference & ops): stable-core vs experimental tiers, and — because via binds state by struct field and routes actions by method name — exactly what counts as a breaking change (exported field names/order +via:tags, root method names) and that the URL route is the in-place evolution seam.Full
ci-check.shgreen.