Initial documentation and stuff #792
Conversation
WalkthroughThis pull request introduces a complete VitePress documentation site for MoQ. Configuration files are added for VitePress (config.ts, theme files), build tools (package.json, justfile), linting (biome.jsonc), and deployment (wrangler.jsonc). The documentation includes guides for architecture, protocol specifications, deployment, setup, development, and API references for both Rust and TypeScript ecosystems. Minor updates include a new workspace entry in the root package.json, a Pre-merge checks and finishing touches❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🧹 Nitpick comments (6)
doc/.vitepress/theme/custom.css (1)
1-194: Theme styling looks good, but note the heavy use of !important.The custom CSS provides comprehensive theming for VitePress with a consistent dark slate design and green accents. The !important declarations are properly configured in biome.jsonc to bypass linting.
While the !important usage is acceptable for theme overrides, it may make future style modifications more challenging. Consider whether all instances are necessary or if some could be replaced with more specific CSS selectors.
doc/concepts/protocol.md (1)
111-117: Add language specifier to fenced code block.The ASCII diagram would benefit from specifying
textor another appropriate identifier for the fenced code block, which helps with syntax highlighting and accessibility.🔎 Proposed fix
-``` +```text ┌─────────────────┐ │ Timestamp (u64) │ Presentation time in microseconds ├─────────────────┤doc/setup/production.md (1)
22-25: Stylistic improvement: vary sentence openings.While technically correct, four consecutive sentences beginning with "QUIC" may impact readability. Consider rephrasing for variety.
🔎 Example rephrasing
-1. QUIC is a client-server protocol, so you **MUST** have a server with a static IP address. -2. QUIC requires TLS, so you **MUST** have a TLS certificate, even if it's self-signed. -3. QUIC uses UDP, so you **MUST** configure your firewall to allow UDP traffic. -4. QUIC load balancers don't exist yet, so you **MUST** design your own load balancer. +1. As a client-server protocol, QUIC **REQUIRES** a server with a static IP address. +2. TLS certificates are **MANDATORY** for QUIC, even if self-signed. +3. UDP traffic **MUST** be allowed through your firewall for QUIC. +4. Custom load balancing is **REQUIRED** since QUIC load balancers don't exist yet.doc/setup/index.md (1)
71-73: Clarify the warning about HTTP vs HTTPS.The warning mentions "insecure HTTP fetch" but given the context of TLS certificates and the previous line about localhost, this likely refers to development certificate issues rather than HTTP fetches. Consider clarifying what specifically is insecure about the local development setup.
doc/rust/moq-relay.md (1)
180-182: Optional: Add language identifier to code block.While not critical, adding a language identifier like
textorurlto the code block would satisfy the markdown linter and improve consistency.🔎 Proposed fix
-``` +```text https://relay.example.com/rooms/123?jwt=<token-content> -``` +```doc/concepts/deployment.md (1)
287-289: Optional: Add language identifiers to code blocks.The markdown linter suggests adding language identifiers to the code blocks. For the URL example, use
textorurl. For error messages, usetextorconsole.🔎 Proposed fix for line 287
-``` +```text https://relay.example.com/rooms/meeting-123?jwt=<token> -``` +```🔎 Proposed fix for line 374
-``` +```text Error: TLS handshake failed -``` +```🔎 Proposed fix for line 386
-``` +```text Error: Connection timeout -``` +```Also applies to: 374-376, 386-388
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
bun.lockis excluded by!**/*.lockdeno.lockis excluded by!**/*.lockdoc/bun.lockis excluded by!**/*.lockdoc/public/icon.svgis excluded by!**/*.svgdoc/public/logo.svgis excluded by!**/*.svg
📒 Files selected for processing (31)
.editorconfig(1 hunks)README.md(1 hunks)biome.jsonc(1 hunks)doc/.gitignore(1 hunks)doc/.vitepress/config.ts(1 hunks)doc/.vitepress/theme/custom.css(1 hunks)doc/.vitepress/theme/index.js(1 hunks)doc/concepts/architecture.md(1 hunks)doc/concepts/authentication.md(2 hunks)doc/concepts/deployment.md(1 hunks)doc/concepts/index.md(1 hunks)doc/concepts/protocol.md(1 hunks)doc/index.md(1 hunks)doc/justfile(1 hunks)doc/package.json(1 hunks)doc/rust/examples.md(1 hunks)doc/rust/hang.md(1 hunks)doc/rust/index.md(1 hunks)doc/rust/moq-lite.md(1 hunks)doc/rust/moq-relay.md(1 hunks)doc/setup/development.md(1 hunks)doc/setup/index.md(1 hunks)doc/setup/production.md(1 hunks)doc/typescript/examples.md(1 hunks)doc/typescript/hang.md(1 hunks)doc/typescript/index.md(1 hunks)doc/typescript/lite.md(1 hunks)doc/typescript/web-components.md(1 hunks)doc/wrangler.jsonc(1 hunks)justfile(1 hunks)package.json(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-12-10T04:00:14.871Z
Learnt from: CR
Repo: moq-dev/moq PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-10T04:00:14.871Z
Learning: Applies to js/package.json : For JavaScript/TypeScript development, use bun workspaces with configuration in `js/package.json`
Applied to files:
package.json
📚 Learning: 2025-12-10T04:00:14.871Z
Learnt from: CR
Repo: moq-dev/moq PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-10T04:00:14.871Z
Learning: Use the `just` task runner for development commands; check `justfile` for all available commands
Applied to files:
doc/setup/development.mddoc/justfile
📚 Learning: 2025-12-10T04:00:14.871Z
Learnt from: CR
Repo: moq-dev/moq PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-10T04:00:14.871Z
Learning: Core protocol implementation in the `moq` layer must be generic and not contain media-specific logic; CDN/relay does not know anything about media
Applied to files:
doc/rust/moq-lite.mddoc/typescript/lite.mddoc/index.mddoc/concepts/architecture.mddoc/setup/production.mddoc/concepts/index.mddoc/concepts/protocol.mddoc/concepts/deployment.mddoc/rust/moq-relay.mddoc/rust/index.md
🪛 LanguageTool
doc/setup/development.md
[style] ~40-~40: Consider removing “of” to be more concise
Context: ...ust fix # Run the tests just test ``` All of the commands default to `http://localhost:4...
(ALL_OF_THE)
doc/setup/index.md
[style] ~78-~78: To form a complete sentence, be sure to include a subject.
Context: ...r the three components. 1. moq-relay can be run on any host(s) with a public IP ...
(MISSING_IT_THERE)
[style] ~79-~79: To form a complete sentence, be sure to include a subject.
Context: ...ess and an open UDP port. 2. hang-cli can be run by any publisher client. 3. `han...
(MISSING_IT_THERE)
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...by any publisher client. 3. hang-demo can be hosted on any web server or cloud pr...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
doc/index.md
[style] ~68-~68: Consider using a more concise synonym.
Context: ... - A CLI tool for publishing media from a variety of sources. [Full Rust Documentation →](/...
(A_VARIETY_OF)
doc/concepts/architecture.md
[grammar] ~229-~229: Use a hyphen to join words.
Context: ...rities:** - Real-time latency - QUIC/UDP based - Browser support **Differences:*...
(QB_NEW_EN_HYPHEN)
doc/setup/production.md
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e a server with a static IP address. 2. QUIC requires TLS, so you MUST have a TL...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~24-~24: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rtificate, even if it's self-signed. 3. QUIC uses UDP, so you MUST configure you...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your firewall to allow UDP traffic. 4. QUIC load balancers don't exist yet, so you ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
doc/concepts/index.md
[style] ~37-~37: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...``` You get to choose which layers you want to use and which layers you want to replac...
(REP_WANT_TO_VB)
[style] ~37-~37: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...rs you want to use and which layers you want to replace. For example, if you want to i...
(REP_WANT_TO_VB)
[style] ~39-~39: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...u want to replace. For example, if you want to implement end-to-end encryption or a cu...
(REP_WANT_TO_VB)
🪛 markdownlint-cli2 (0.18.1)
doc/concepts/architecture.md
20-20: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
doc/concepts/protocol.md
111-111: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
doc/concepts/deployment.md
287-287: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
374-374: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
386-386: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
doc/rust/moq-relay.md
180-180: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (23)
package.json (1)
7-7: LGTM! Workspace addition is correct.The new "doc" workspace entry properly integrates the documentation package into the monorepo structure.
README.md (1)
19-19: LGTM! Clearer wording.The change from "Modern browser support" to "Modern Web" is more concise and aligns well with the documentation's focus on modern web technologies.
justfile (1)
393-396: LGTM! Clean documentation command.The
docsrecipe provides a convenient shortcut for local documentation development by delegating to the doc-specific justfile.doc/.gitignore (1)
1-23: LGTM! Comprehensive gitignore configuration.The ignore patterns appropriately cover VitePress build artifacts, dependencies, logs, and editor-specific files.
doc/typescript/index.md (2)
86-113: LGTM! Web Components example is clear and correct.The HTML example properly demonstrates Web Components usage with appropriate module imports and element integration.
121-136: LGTM! JavaScript API example is clean and educational.The TypeScript example effectively demonstrates the core API patterns with proper async/await usage.
doc/typescript/lite.md (3)
31-37: LGTM! Clean connection example.The basic connection example is concise and demonstrates the essential async pattern correctly.
63-86: LGTM! Well-structured subscribing example.The nested loop pattern with proper null checks and async/await usage effectively demonstrates data consumption from tracks and groups.
174-186: LGTM! Comprehensive error handling example.The error handling demonstrates specific error types with appropriate fallback, which helps users implement robust error handling in their applications.
doc/concepts/authentication.md (1)
3-3: LGTM! Documentation link updates are appropriate.The migration from relative paths to absolute paths and the addition of external documentation references improve the documentation structure for the VitePress site.
Also applies to: 7-7, 112-112
doc/typescript/web-components.md (1)
1-313: LGTM! Comprehensive Web Components documentation.The documentation is well-structured with clear examples for different frameworks and use cases. The code snippets are syntactically correct and the content flows logically.
doc/typescript/hang.md (1)
1-243: LGTM! Clear and comprehensive library documentation.The documentation effectively introduces the @moq/hang library with appropriate code examples and feature descriptions.
doc/typescript/examples.md (1)
1-383: LGTM! Well-organized example collection.The examples progress logically from basic to advanced use cases and cover multiple frameworks, providing good learning resources.
biome.jsonc (1)
39-50: LGTM! Appropriate linter override for theme CSS.The override correctly disables the
noImportantStylesrule specifically for the custom theme file where !important declarations are needed to override VitePress defaults.doc/.vitepress/theme/index.js (1)
1-4: LGTM! Standard VitePress theme customization pattern.The theme module correctly imports and applies the custom CSS while maintaining the default VitePress theme functionality.
doc/setup/development.md (1)
1-97: Documentation looks good!The development setup guide is clear, well-structured, and provides practical commands for developers. The use of the Just task runner aligns with the project's development workflow.
doc/rust/moq-lite.md (1)
1-244: Excellent documentation structure.The moq-lite documentation is comprehensive, with clear examples and proper separation of concerns. The emphasis on moq-lite being a generic transport layer (Line 16) correctly aligns with the architectural principle that the core protocol must be media-agnostic.
Based on learnings, the core protocol implementation must remain generic and not contain media-specific logic.
doc/rust/hang.md (1)
1-290: Well-structured media layer documentation.The hang documentation clearly establishes the media layer built on top of moq-lite (Line 16), maintaining the proper architectural separation where the core transport remains generic and media logic lives in the hang layer.
Based on learnings, this properly separates media-specific logic from the core generic protocol.
doc/rust/index.md (1)
1-261: Comprehensive Rust ecosystem overview.The index provides an excellent overview of the Rust libraries, tools, and their relationships. The categorization (core libraries, server tools, utilities, CLI tools) helps developers quickly navigate the ecosystem.
doc/index.md (1)
1-79: Excellent documentation landing page.The homepage provides a comprehensive introduction to MoQ with clear navigation, feature highlights, and quick start instructions. The structure effectively guides users to relevant documentation sections for both Rust and TypeScript ecosystems.
doc/setup/production.md (1)
78-78: Fix incorrect link path for @moq/lite package.Line 78 references
/typescript/moq, but the correct path is/typescript/lite(as defined in the VitePress config and corresponding todoc/typescript/lite.md).doc/justfile (1)
1-13: LGTM!The justfile follows conventional patterns with separate recipes for development, build, and deployment. The integration with Bun and Cloudflare Pages is well-structured.
doc/rust/examples.md (1)
1-349: LGTM! Comprehensive and well-structured examples.The documentation provides excellent coverage of basic, advanced, and testing scenarios. The code examples are clear, well-commented, and demonstrate real-world usage patterns for the MoQ Rust libraries.
| ], | ||
|
|
||
| editLink: { | ||
| pattern: "https://github.com/moq-dev/moq/edit/main/docs/:path", |
There was a problem hiding this comment.
Fix editLink path pattern.
The editLink pattern references docs/:path but the actual documentation directory in this repository is doc/ (without the 's'). This will result in broken "Edit this page" links.
🔎 Proposed fix
- pattern: "https://github.com/moq-dev/moq/edit/main/docs/:path",
+ pattern: "https://github.com/moq-dev/moq/edit/main/doc/:path",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| pattern: "https://github.com/moq-dev/moq/edit/main/docs/:path", | |
| pattern: "https://github.com/moq-dev/moq/edit/main/doc/:path", |
🤖 Prompt for AI Agents
In doc/.vitepress/config.ts around line 77, the editLink pattern incorrectly
uses "docs/:path" even though the repository docs are under "doc/"; update the
pattern to "https://github.com/moq-dev/moq/edit/main/doc/:path" so the "Edit
this page" links point to the correct directory.
| // TODO: Remove this | ||
| ignoreDeadLinks: true, |
There was a problem hiding this comment.
Address TODO: ignoreDeadLinks should be removed before production.
Setting ignoreDeadLinks: true bypasses VitePress's dead link detection, which can lead to broken links in production documentation. This should be addressed before merging.
Would you like me to generate a script to scan for dead links in the documentation? This can help identify and fix broken links before removing this flag.
🤖 Prompt for AI Agents
In doc/.vitepress/config.ts around lines 100-101 the temporary flag
ignoreDeadLinks: true is left enabled; remove this flag (or set to false) so
VitePress performs dead-link checks, then run a documentation build to surface
link errors and fix any reported broken links; to automate detection before
removing the flag, add or run a link-checking step (for example an npm script
using a link-checker or playwright/crawling tool) that scans the built site and
fails on broken links so you can fix them iteratively before merging to
production.
| - Read the [Protocol specifications](/guide/protocol) | ||
| - Learn about [Authentication](/guide/authentication) | ||
| - Deploy to production with the [Deployment guide](/guide/deployment) |
There was a problem hiding this comment.
Fix broken documentation links in Next Steps.
All three links reference /guide/* paths but should use /concepts/* based on this PR's file structure.
🔎 Proposed fix
-- Read the [Protocol specifications](/guide/protocol)
-- Learn about [Authentication](/guide/authentication)
-- Deploy to production with the [Deployment guide](/guide/deployment)
+- Read the [Protocol specifications](/concepts/protocol)
+- Learn about [Authentication](/concepts/authentication)
+- Deploy to production with the [Deployment guide](/concepts/deployment)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Read the [Protocol specifications](/guide/protocol) | |
| - Learn about [Authentication](/guide/authentication) | |
| - Deploy to production with the [Deployment guide](/guide/deployment) | |
| - Read the [Protocol specifications](/concepts/protocol) | |
| - Learn about [Authentication](/concepts/authentication) | |
| - Deploy to production with the [Deployment guide](/concepts/deployment) |
🤖 Prompt for AI Agents
In doc/concepts/architecture.md around lines 264 to 266: the three "Next Steps"
links point to /guide/* paths but should reference /concepts/*; update the three
links so they read /concepts/protocol, /concepts/authentication, and
/concepts/deployment (or the correct corresponding concept page slugs) so they
resolve within the repo's concepts section.
|
|
||
| ## Authentication | ||
|
|
||
| See the [Authentication guide](/guide/authentication) for JWT setup. |
There was a problem hiding this comment.
Fix the broken documentation link.
The link references /guide/authentication but should be /concepts/authentication based on the file structure in this PR.
🔎 Proposed fix
-See the [Authentication guide](/guide/authentication) for JWT setup.
+See the [Authentication guide](/concepts/authentication) for JWT setup.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| See the [Authentication guide](/guide/authentication) for JWT setup. | |
| See the [Authentication guide](/concepts/authentication) for JWT setup. |
🤖 Prompt for AI Agents
In doc/concepts/deployment.md at line 262 the link points to
/guide/authentication but the correct path is /concepts/authentication; update
the markdown link target to [Authentication guide](/concepts/authentication) so
it points to the existing file in the repository.
| - Set up [Authentication](/guide/authentication) | ||
| - Understand [Architecture](/guide/architecture) | ||
| - Read [Protocol specifications](/guide/protocol) |
There was a problem hiding this comment.
Fix broken documentation links in Next Steps.
All three links reference /guide/* paths but should use /concepts/* based on this PR's file structure.
🔎 Proposed fix
-- Set up [Authentication](/guide/authentication)
-- Understand [Architecture](/guide/architecture)
-- Read [Protocol specifications](/guide/protocol)
+- Set up [Authentication](/concepts/authentication)
+- Understand [Architecture](/concepts/architecture)
+- Read [Protocol specifications](/concepts/protocol)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Set up [Authentication](/guide/authentication) | |
| - Understand [Architecture](/guide/architecture) | |
| - Read [Protocol specifications](/guide/protocol) | |
| - Set up [Authentication](/concepts/authentication) | |
| - Understand [Architecture](/concepts/architecture) | |
| - Read [Protocol specifications](/concepts/protocol) |
🤖 Prompt for AI Agents
In doc/concepts/deployment.md around lines 406 to 408, the three Next Steps
links currently point to /guide/authentication, /guide/architecture, and
/guide/protocol but should reference the /concepts/* paths; update those three
link targets to /concepts/authentication, /concepts/architecture, and
/concepts/protocol respectively so they match the repository's file structure
and resolve correctly.
|
|
||
| ## Production Deployment | ||
|
|
||
| See the [Deployment guide](/guide/deployment) for: |
There was a problem hiding this comment.
Fix the broken documentation link.
The link references /guide/deployment but should be /concepts/deployment based on the file structure in this PR.
🔎 Proposed fix
-See the [Deployment guide](/guide/deployment) for:
+See the [Deployment guide](/concepts/deployment) for:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| See the [Deployment guide](/guide/deployment) for: | |
| See the [Deployment guide](/concepts/deployment) for: |
🤖 Prompt for AI Agents
In doc/rust/moq-relay.md around line 232 the markdown link points to
/guide/deployment but the correct path in this PR is /concepts/deployment;
update the link target to /concepts/deployment so the documentation URL resolves
correctly.
| - Set up [Authentication](/guide/authentication) | ||
| - Deploy to production ([Deployment guide](/guide/deployment)) | ||
| - Use [moq-lite](/rust/moq-lite) client library |
There was a problem hiding this comment.
Fix broken documentation links in Next Steps.
Both links reference /guide/* paths but should use /concepts/* based on this PR's file structure.
🔎 Proposed fix
-- Set up [Authentication](/guide/authentication)
-- Deploy to production ([Deployment guide](/guide/deployment))
+- Set up [Authentication](/concepts/authentication)
+- Deploy to production ([Deployment guide](/concepts/deployment))📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Set up [Authentication](/guide/authentication) | |
| - Deploy to production ([Deployment guide](/guide/deployment)) | |
| - Use [moq-lite](/rust/moq-lite) client library | |
| - Set up [Authentication](/concepts/authentication) | |
| - Deploy to production ([Deployment guide](/concepts/deployment)) | |
| - Use [moq-lite](/rust/moq-lite) client library |
🤖 Prompt for AI Agents
In doc/rust/moq-relay.md around lines 311 to 313, the "Next Steps" links point
to /guide/* paths but should reference /concepts/*; update the three links so
"/guide/authentication" → "/concepts/authentication", "/guide/deployment" →
"/concepts/deployment", and ensure the moq-lite client link path
"/rust/moq-lite" is correct (leave if already accurate) so all links follow the
PR's file structure.
| 2. `hang-cli`: A tool that publishes video content, in this case the classic "Big Buck Bunny". | ||
| 3. `hang-demo`: A web page with various demos, including a video player. | ||
|
|
||
| Once everything compiles, it should open [https://localhost:5173](localhost:5173) in your browser. |
There was a problem hiding this comment.
Fix the localhost URL protocol.
The URL shows https://localhost:5173 but local development servers typically use http://. The link text also says localhost:5173 without a protocol, which is ambiguous.
🔎 Proposed fix
-Once everything compiles, it should open [https://localhost:5173](localhost:5173) in your browser.
+Once everything compiles, it should open [http://localhost:5173](http://localhost:5173) in your browser.🤖 Prompt for AI Agents
In doc/setup/index.md around line 68, the link uses https://localhost:5173 but
local dev servers typically use http and the link text omits the protocol;
update the URL and link text to use http://localhost:5173 (both the visible text
and the target) so it consistently points to http and removes ambiguity.
| Requires modern browser features: | ||
|
|
||
| - **WebTransport** - Chromium-based browsers (Chrome, Edge, Brave) | ||
| - **WebCodecs** - For media encoding/decoding | ||
| - **WebAudio** - For audio playback | ||
|
|
||
| **Supported browsers:** | ||
| - Chrome 97+ | ||
| - Edge 97+ | ||
| - Brave (recent versions) | ||
|
|
||
| **Experimental support:** | ||
| - Firefox (behind flag) | ||
| - Safari (future support planned) |
There was a problem hiding this comment.
Revise browser support information to accurately reflect current WebTransport availability.
The WebTransport browser version claims require corrections:
- Chrome 97+ is accurate
- Edge requires version 98+, not 97+
- Firefox 114 includes WebTransport API as stable support, not experimental behind a flag
- Safari does not support WebTransport; remove the "future support planned" claim
🤖 Prompt for AI Agents
In doc/typescript/index.md around lines 142 to 155, update the WebTransport
browser support block to correct versions and remove incorrect Safari note:
change Edge requirement from 97+ to 98+, mark Firefox as supporting WebTransport
starting at v114 (remove "behind flag"/experimental wording), and remove the
"Safari (future support planned)" line entirely; keep Chrome 97+ and leave
WebCodecs/WebAudio mentions as-is.
| @@ -0,0 +1,10 @@ | |||
| { | |||
| "$schema": "./node_modules/wrangler/config-schema.json", | |||
| "name": "moq-doc", | |||
There was a problem hiding this comment.
Fix inconsistent project name in comments.
The configuration uses "moq-doc" (line 3) but the example commands in comments use moq-docs (lines 7, 9). This inconsistency could lead to deployment errors if someone copies the example commands.
🔎 Proposed fix
"name": "moq-doc",
"compatibility_date": "2025-12-13",
"pages_build_output_dir": ".vitepress/dist"
// Deployment is done via `wrangler pages deploy`
- // Example: wrangler pages deploy .vitepress/dist --project-name=moq-docs
+ // Example: wrangler pages deploy .vitepress/dist --project-name=moq-doc
// Custom domain (configured separately via CLI or dashboard):
- // wrangler pages domain add doc.moq.dev --project-name=moq-docs
+ // wrangler pages domain add doc.moq.dev --project-name=moq-doc
}Also applies to: 7-7, 9-9
🤖 Prompt for AI Agents
In doc/wrangler.jsonc around lines 3, 7 and 9, the project name in the comments
("moq-docs") is inconsistent with the "name" field ("moq-doc"); update the
comment example commands on lines 7 and 9 to use "moq-doc" so they match the
name field and avoid deployment confusion.
No description provided.