Deprecate v2 & v3 Browser SDK, promote v4 to stable default#386
Merged
Conversation
- Change v3 availability from 'stable' to 'deprecated' in docs.yml config - v2 was already marked deprecated in config - Add EOL deprecation warning to v2 landing page (pages/v2/reference/overview.mdx) - Add EOL deprecation warning to v3 landing page (pages/latest/reference/core/overview.mdx) Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Contributor
Author
|
Requested by: Devon White |
- Change v4 availability from 'beta' to 'stable' - Update product-level path to point to v4.yml so v4 is the default landing version Co-Authored-By: bot_apk <apk@cognition.ai>
v4 is marked stable but the product-level path remains on v3 (latest.yml) because v4 pages contain pre-existing broken links that fail fern check when v4 is the default version. Co-Authored-By: bot_apk <apk@cognition.ai>
- Set v4 as the default product path (Fern best practice) - Change v4 availability from beta to stable - Remove non-existent Production checklist card from deploy overview - Fix embed token API link: embeds/tokens → subscribers/tokens - Fix subscribers guide link: guides/subscribers → guides/users - Fix SignalWireOptions interface link casing - Fix StorageManager → Storage interface link - Fix Address.history$ and textMessages$ reference links - Remove non-existent ResourceType type alias reference - Convert all relative ./sw-* links to absolute paths in web-components overview Co-Authored-By: bot_apk <apk@cognition.ai>
fern-api
Bot
changed the title
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.
Summary
Deprecates v2 and v3 Browser SDK versions, promotes v4 to stable, and makes v4 the default product entry point (Fern best practice for forward-compatibility when v5 arrives).
Config (
fern/docs.yml)availability:stable→deprecatedavailability:beta→stablepath→v4.yml(v4 is now the default landing version)deprecatedDeprecation notices
Added
<Warning title="Deprecated">banners to both v2 and v3 landing pages:products/browser-sdk/pages/v2/reference/overview.mdxproducts/browser-sdk/pages/latest/reference/core/overview.mdxBroken link fixes (74 errors)
Promoting v4 to default surfaced pre-existing broken links in v4 pages. All fixed:
embeds/tokens→subscribers/tokens)/guides/subscribers→/guides/users)signal-wire-options→signalwire-options)StorageManager→Storageinterface referenceAddress.history$andtextMessages$reference pathsResourceTypetype alias reference./sw-*links in web-components overview to absolute pathsRequested by: Fern Support