docs(api-stability): add the 2.0 breaking-changes ledger#241
Merged
Conversation
Split the "slated for removal in 2.0" section into two inventories — the existing template / pre-rebuild-alias list, and a new ledger for every other public-API compromise that had to ship Stable. The ledger records when a Stable shape we already intend to change could not be made Beta, with the 2.0 action and deprecation plan; it starts empty.
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.
Why
docs/api-stability.md§ "Currently slated for removal in 2.0" pointed only at the template/alias deprecation inventory. Thegraphcompose-senior-reviewskill (Lane 1.5) refers to a general "2.0 breaking-changes ledger" for any Stable public-API compromise — but that ledger didn't exist as a document, so a compromise had nowhere to be recorded.What changed
@Beta, with the 2.0 action and deprecation plan. It explains the@Betaescape hatch (no row, no debt) and that a// TODO(v2)comment is not a record.@Beta(e.g. the multi-section assembly seam), so there is no debt to record yet.Docs-only; no code or public surface change.