Skip to content

Remove Browser SDK v3 guides - #553

Merged
hey-august merged 3 commits into
mainfrom
august-20260807-remove-browser-v3-guides
Aug 10, 2026
Merged

Remove Browser SDK v3 guides#553
hey-august merged 3 commits into
mainfrom
august-20260807-remove-browser-v3-guides

Conversation

@hey-august

Copy link
Copy Markdown
Collaborator

Description

Per @briankwest , the Browser SDK v3 guides are retired. This removes them and leaves v3 as reference-only, like v2.

What changed

  • Deleted fern/products/browser-sdk/pages/v3/guides/ — 10 published guides plus 6 unpublished .draft files.
  • Removed the guides tab from fern/products/browser-sdk/versions/v3.yml. The reference and click-to-call tabs are untouched; Click-to-Call lives outside pages/v3/ and is hard-linked from versions/v4.yml, so it survives.
  • Added four redirects in fern/docs.yml covering both the /v3/js/guides* and legacy /js/guides* paths.
  • Fixed the four inbound links from pages that survive.
  • Deleted 13 images/videos used only by the removed guides.

Note

Several removed guides covered recording, RTMP streaming, and interactive live streaming. v4 does not implement those features yet.

Redirects management

The new rules are placed above the existing /docs/browser-sdk/js/:slug* wildcard. That wildcard currently routes legacy guide paths into the v3 tree; left first, it would send them into pages that no longer exist.

Inbound link fixes

File Change
platform/.../setup/api-credentials.mdx Video and Chat bullets now cite the Create Room Token / Create Chat Token endpoints instead of the deleted demos; the generic "Guide" link goes to the v4 guides overview
browser-sdk/pages/v3/reference/video/RoomSession/index.mdx Points at the Create Room Token endpoint reference
snippets/browser-sdk/v3/installation.mdx Dropped the "Guides & Examples" card — its href (/v3/guides) was already broken, since the real slug was /js/guides

Verification

yarn fern-check and yarn fern-md-check (the two commands CI runs) both pass with 0 errors. The single warning is a pre-existing accent-color contrast note, unrelated to this branch.

Against a Fern preview deploy:

  • All five representative old guide URLs return 308 to the migration guide, including the legacy un-versioned forms.
  • The sitemap contains zero js/guides entries.
  • The 169 v3 reference pages and the Click-to-Call tab still return 200.
  • The edited api-credentials page renders the new endpoint links with no stale references.

Notes for the reviewer

Kept fern/assets/images/video/layouts/ (21 layout previews) and overlay-animation.gif. These were referenced only by the unpublished drafts, so they were never live, and the current v4 layouts guide discusses those same layout names without images of its own. They look more like material for that guide than debris from this removal.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Code cleanup / refactor

Related Issues

#551

Testing

  • Added/updated unit tests
  • Tested manually
  • Tested with live SignalWire credentials (if applicable)

Checklist

  • I have read the CONTRIBUTING guidelines
  • My code follows the project's style guidelines
  • I have added tests for my changes (if applicable)
  • I have updated documentation (if applicable)
  • All existing tests pass

@github-actions

Copy link
Copy Markdown
Contributor

@Devon-White
Devon-White self-requested a review August 10, 2026 12:02
@hey-august
hey-august merged commit 949d588 into main Aug 10, 2026
2 checks passed
@hey-august
hey-august deleted the august-20260807-remove-browser-v3-guides branch August 10, 2026 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants