docs: rewrite README to house standard - #6
Conversation
Expand the README to WAVE's house style (badges, quick start, links row, grounded status/usage sections) while keeping every capability claim traceable to something actually in this repo (source, package.json, capabilities.json, or the published npm/registry artifact).
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_e6bc7c10-6063-4d95-a236-027518c4d67d) |
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 2 minutes Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Comment |
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTo customize comments, go to the Qodo configuration screen, or learn more in the docs. |
ApprovabilityVerdict: Approved ae11364 Documentation-only change to README.md — reformatting, adding badges, and expanding descriptions. No code or runtime behavior affected. You can customize Macroscope's approvability policy. Learn more. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
PR Summary by Qododocs: rewrite README to WAVE house standard (badges, links, grounded module notes)
AI Description
Diagram
High-Level Assessment
Files changed (1)
|
Qodo FixerNo findings are available for this PR yet. Findings appear here once Qodo has reviewed the PR. |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 1 file
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Architecture diagram
sequenceDiagram
participant User as Browser User
participant HTML as console/index.html
participant UI as Console UI (session.js)
participant Player as moq-player.js
participant Wire as moq-wire-browser.js
participant Gateway as WAVE Gateway (POST /api/v1/crest/session)
participant Relay as MoQ Relay (wss://moq.wave.online)
Note over User,Relay: Crest Console — Browser MoQ Player & Console
User->>HTML: Open http://localhost:8080/?relay=&ns=&track=
HTML->>HTML: Parse query params (?relay, ?ns, ?track)
alt No relay param
Note over HTML: Default relay: wss://moq.wave.online
end
HTML->>UI: Init console with params
Note over UI,Relay: Step 1 — Open Crest Ingest Session
UI->>Gateway: POST /api/v1/crest/session (same-origin proxy)
Gateway-->>UI: Return session (namespace + track)
UI->>UI: Store returned namespace/track
Note over UI,Relay: Step 2 — Subscribe & Decode Track
UI->>Player: subscribeToTrack(namespace, track, relayUrl)
Player->>Relay: WebSocket connect (wss://moq.wave.online)
Player->>Wire: Port MoQ draft-18 wire messages (SETUP, SUBSCRIBE, PUBLISH, FETCH, NAMESPACE)
Wire-->>Player: Encode/decode message buffers (Uint8Array)
Player->>Relay: Subscribe to track via MoQ protocol
Relay-->>Player: H.264 access units over WebSocket
Player->>Player: Reassemble H.264 Annex-B access units
alt Chrome/Chromium with proprietary codecs
Player->>Player: WebCodecs VideoDecoder API decode
Player-->>HTML: Draw frames to <canvas>
else Other browsers (no H.264 decode)
Note over Player,HTML: H.264 decode unsupported — no video output
end
HTML-->>User: Display decoded video in canvas
Approval not submitted
This repository is configured to approve as @yakimoto, but that approval identity is unavailable.
GitHub does not allow a pull request author approval to count for their own PR.
cubic left this as a normal review comment instead of falling back to a Cubic App approval.
1 participant
Summary
Test plan
npm run servestill matches package.json'sservescriptNote
Low Risk
Documentation-only README changes with no runtime or dependency impact.
Overview
Reformats README.md to WAVE’s house layout: centered title (
crest-console), badge row, and a links line (Live · wave.online · github), plus a footer with company/docs links.The technical content is expanded and clarified rather than replaced: each
console/file is described with more detail from the source (MoQ wire message types, WebCodecs/H.264/Chrome codec note,POST /api/v1/crest/sessiongateway proxy). The Run it section spells out the?relay=&ns=&track=query params and notes the default relaywss://moq.wave.online. License line updates entity name to “WAVE Online, LLC”; open-core wording is tightened slightly (“client here” vs “client”).Reviewed by Cursor Bugbot for commit ae11364. Configure here.