Skip to content

Add react native tutorials#265

Open
Karolk99 wants to merge 5 commits into
mainfrom
moq-react-native
Open

Add react native tutorials#265
Karolk99 wants to merge 5 commits into
mainfrom
moq-react-native

Conversation

@Karolk99

Copy link
Copy Markdown
Contributor

Description

Describe your changes in detail

Comment thread .claude/settings.json Outdated
Comment thread docs/moq/tutorials/react-native-publishing.mdx Outdated
Comment thread docs/moq/tutorials/react-native-publishing.mdx Outdated
@Karolk99 Karolk99 marked this pull request as ready for review June 19, 2026 10:46
@Karolk99 Karolk99 requested a review from Copilot June 19, 2026 10:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reorganizes and expands the Media over QUIC (MoQ) documentation by introducing a dedicated MoQ top-level navigation tab with its own sidebar, and by splitting/adding MoQ tutorials for both web and React Native.

Changes:

  • Added a new moqSidebar and updated sidebar generation to prevent MoQ docs from appearing in the main Docs sidebar.
  • Added a MoQ navbar entry (pointing at /next/...) and introduced redirects for legacy MoQ doc routes.
  • Created/updated MoQ docs structure: Concepts + Tutorials categories, plus new Web Publishing and React Native Publishing/Subscribing tutorials, and refactored the existing web tutorial into “Web Subscribing”.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
sidebars/docs.ts Adds a dedicated moqSidebar autogenerated from docs/moq.
redirects/index.ts Adds redirect rules for older MoQ doc paths to the new MoQ section paths.
docusaurus.config.ts Filters MoQ category out of the main docs sidebar and adds a MoQ navbar tab.
docs/moq/tutorials/web-subscribing.mdx Refactors the existing MoQ tutorial into a focused web subscribing guide and updates links/structure.
docs/moq/tutorials/web-publishing.mdx Adds a new web publishing tutorial.
docs/moq/tutorials/react-native-subscribing.mdx Adds a new React Native subscribing tutorial using react-native-moq.
docs/moq/tutorials/react-native-publishing.mdx Adds a new React Native publishing tutorial using react-native-moq.
docs/moq/tutorials/category.json Adds Tutorials category metadata for MoQ docs.
docs/moq/concepts/moq-with-fishjam.mdx Renames/repositions the MoQ concept doc and updates cross-links.
docs/moq/concepts/category.json Adds Concepts category metadata for MoQ docs.
docs/moq/category.json Adds MoQ root category metadata and customProps.topNavSection used for sidebar filtering.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docusaurus.config.ts Outdated
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# React Native Publishing

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: the react native publishing/subscribing title is not self explanatory. i'd add the moq or stream keyword to that

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I encourage you to start it locally, there is a separate tab called moq in which these tutorials are located

Comment thread docs/moq/tutorials/react-native-publishing.mdx Outdated
@Karolk99 Karolk99 requested review from czerwiukk June 19, 2026 12:48
@czerwiukk

czerwiukk commented Jun 19, 2026

Copy link
Copy Markdown
Member
image image

Why not nest MoQ tutorials like web&mobile/backend in how to section? IMO creating a separate sidebar makes it harder to navigate in the docs. I'm not sure splitting our docs in half around the webrtc/moq distinction is a good idea.
also - "moq subscribing/publishing" seems like a diataxis "goal", so the moq articles could fit in the how to -> moq location.

@Karolk99

Karolk99 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

image image

Why not nest MoQ tutorials like web&mobile/backend in how to section? IMO creating a separate sidebar makes it harder to navigate in the docs. I'm not sure splitting our docs in half around the webrtc/moq distinction is a good idea.

In my opinion split is necessary, because non of the docs from WebRTC section relates to MoQ so it's misleading without this destinction

@PiotrWodecki

Copy link
Copy Markdown
Member

@czerwiukk the issue is that many of our features do not work with moq which is not immediately obvious (agents, VAD, etc.), so the split is there to make that more obvious. Initially I was hoping we could keep it merged, but I don't see how it would make sense this way.

@czerwiukk

Copy link
Copy Markdown
Member

split is there to make that more obvious

I'd put a big warning note in the MoQ concept article explicitly stating whats possible and what not. Putting everything in a separate tab doesn't suggest the features aren't interoperable. If we want to ship quick, let's make small changes and iterate, rather than introduce concepts on the fly that feel intuitive to us, not necessarily the end user.

@PiotrWodecki PiotrWodecki left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm contentwise, but the separation needs slightly better execution

Comment thread sidebars/docs.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (blocking): I really don't like the idea of calling this section WebRTC. The split seems necessary, for now, but we shouldn't drop the idea of someone not needing to know what WebRTC is.

Image

I don't have a better suggestion for now, but we need it.

To start publishing a MoQ stream, you need two things: a _publisher token_ and the relay URL. We show how to quickly prototype with the [Sandbox API](#quickstart-with-the-sandbox-api) and how to get ready for [production](#production-with-server-sdks).

:::tip
MoQ is a protocol with a well-defined negotiation, so in theory any compliant MoQ client should work. That said, we recommend using the `@moq` client libraries — the reference TypeScript implementation maintained alongside the protocol. For more details, see the [documentation](https://doc.moq.dev/lib/js/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: @moq misses a link

@PiotrWodecki

Copy link
Copy Markdown
Member

split is there to make that more obvious

I'd put a big warning note in the MoQ concept article explicitly stating whats possible and what not. Putting everything in a separate tab doesn't suggest the features aren't interoperable. If we want to ship quick, let's make small changes and iterate, rather than introduce concepts on the fly that feel intuitive to us, not necessarily the end user.

I agree this could work, let's give it a try @Karolk99

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.

5 participants