docs: add versioned API references - #140
Merged
Merged
Conversation
|
🎉 This PR is included in version 1.18.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Keep earlier API references available as the schema evolves. Add website-only snapshots and a compact version menu, with navigation disabled by default. The initial catalogue contains only the current reference.
Existing schema URLs, package exports, npm publishing and SDK generation retain their current behaviour. Snapshot capture resolves example file references so archived pages can build independently of live schema files.
Verify: Node 22 type check, all 71 schema smoke checks and reference-version tests pass. Package files and the default website output match the baseline. Checked desktop, mobile and keyboard navigation locally.
Risk: removing a catalogue entry removes that archive on the next website deployment. Keep entries while their references are supported.