Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation links and code examples to reflect recent SDK/API doc structure changes (likely from Typedoc output changes after submodule reorg), across current and versioned docs.
Changes:
- Adjusts many internal doc links (especially API reference links) and some “data channels” cross-references.
- Removes or rewrites links where corresponding API pages no longer exist in a given version.
- Adds Twoslash
// @errors: 2739directives to several React Native code snippets to stabilize docs builds.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-0.25.0/tutorials/livestreaming.mdx | Removes link to CallKit hook (keeps inline code) in v0.25.0 tutorial. |
| versioned_docs/version-0.25.0/how-to/features/text-chat.mdx | Fixes Data Channels relative link; adjusts API reference links for v0.25.0. |
| versioned_docs/version-0.25.0/how-to/client/background-streaming.mdx | Removes CallKit API links (keeps inline code) in v0.25.0. |
| versioned_docs/version-0.25.0/explanation/data-channels.mdx | Removes mobile API link for useDataChannel in v0.25.0 explanation. |
| versioned_docs/version-0.25.0/examples/react.mdx | Updates “data channels” link to point to explanation page. |
| versioned_docs/version-0.25.0/examples/react-native.mdx | Updates “data channels” link to point to explanation page. |
| versioned_docs/version-0.24.0/tutorials/livestreaming.mdx | Fixes relative path to CallKit API doc in v0.24.0. |
| versioned_docs/version-0.24.0/how-to/react-native/custom-video-sources/index.mdx | Updates links for custom video source guides (currently incorrect as authored). |
| versioned_docs/version-0.24.0/examples/index.mdx | Adds placeholder “Examples” index page for v0.24.0. |
| versioned_docs/version-0.23.0/how-to/react-native/custom-video-sources/index.mdx | Updates links for custom video source guides (currently incorrect as authored). |
| versioned_docs/version-0.23.0/examples/index.mdx | Adds placeholder “Examples” index page for v0.23.0. |
| docs/tutorials/react-native-quick-start.mdx | Adds Twoslash expected error directives to RN snippets. |
| docs/tutorials/livestreaming.mdx | Updates CallKit API link path. |
| docs/how-to/features/text-chat.mdx | Fixes Data Channels relative link; updates useDataChannel API links. |
| docs/how-to/client/start-streaming.mdx | Updates useMicrophone API link path. |
| docs/how-to/client/screensharing.mdx | Updates useScreenShare API link paths + anchors. |
| docs/how-to/client/picture-in-picture.mdx | Adds Twoslash expected error directives to RN snippets. |
| docs/how-to/client/migration-guide.mdx | Adds Twoslash expected error directives to RN snippets. |
| docs/how-to/client/managing-devices.mdx | Updates useMicrophone API link paths. |
| docs/how-to/client/list-other-peers.mdx | Adds Twoslash expected error directive to RN snippet. |
| docs/how-to/client/background-streaming.mdx | Updates CallKit API links from variables to functions. |
| docs/examples/react.mdx | Updates “data channels” link to point to explanation page. |
| docs/examples/react-native.mdx | Updates “data channels” link to point to explanation page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+13
to
+14
| - [Custom Source](./custom-video-sources/overview) - Learn how to create a basic custom video source | ||
| - [Vision Camera](./custom-video-sources/vision-camera) - Learn how to implement Vision Camera as a custom video source |
There was a problem hiding this comment.
The links add an extra custom-video-sources/ path segment. Since this file already lives in .../custom-video-sources/, ./custom-video-sources/overview resolves to .../custom-video-sources/custom-video-sources/overview (non-existent). Link directly to the sibling docs (e.g., ./overview and ./vision-camera) or use the correct relative path from this directory.
Suggested change
| - [Custom Source](./custom-video-sources/overview) - Learn how to create a basic custom video source | |
| - [Vision Camera](./custom-video-sources/vision-camera) - Learn how to implement Vision Camera as a custom video source | |
| - [Custom Source](./overview) - Learn how to create a basic custom video source | |
| - [Vision Camera](./vision-camera) - Learn how to implement Vision Camera as a custom video source |
Comment on lines
+13
to
+14
| - [Custom Source](./custom-video-sources/overview) - Learn how to create a basic custom video source | ||
| - [Vision Camera](./custom-video-sources/vision-camera) - Learn how to implement Vision Camera as a custom video source |
There was a problem hiding this comment.
The links add an extra custom-video-sources/ path segment. Since this file already lives in .../custom-video-sources/, ./custom-video-sources/overview resolves to .../custom-video-sources/custom-video-sources/overview (non-existent). Link directly to the sibling docs (e.g., ./overview and ./vision-camera) or use the correct relative path from this directory.
Suggested change
| - [Custom Source](./custom-video-sources/overview) - Learn how to create a basic custom video source | |
| - [Vision Camera](./custom-video-sources/vision-camera) - Learn how to implement Vision Camera as a custom video source | |
| - [Custom Source](./overview) - Learn how to create a basic custom video source | |
| - [Vision Camera](./vision-camera) - Learn how to implement Vision Camera as a custom video source |
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
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.
Description
Fixes broken links and type issues.