Skip to content

docs: fix stale examples and checkpoint documentation audit - #5974

Merged
kixelated merged 10 commits into
mainfrom
quest/m0/audit-docs
Oct 20, 2026
Merged

kixelated merged 10 commits into
mainfrom
quest/m0/audit-docs

Conversation

@kixelated

@kixelated kixelated commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

The production setup still used the retired relay auth.key setting. Codec support, Rust driver setup, snapshot staleness, and several API references also lagged current main.

Approach

Fix those pages and adjacent snapshot API comments. Replace unavailable API destinations with verified source links. Keep the audit quest open with its coverage baseline and remaining work; this run is incomplete, so no recurring successor is added.

Iterate round: merged origin/main, resolving the doc/bin/cli.md conflict onto main's rewritten MPEG-TS paragraph. Dropped the "(up to 7.1)" qualifier on TS Opus, since the importer's explicit channel layout (channel_config_code 0x81) also accepts more than eight channels.

Impact

  • Public API: documentation and comments only; no exported signatures or behavior change.
  • Wire: none.

Decisions

  • TS Opus channel claim: ✅ say "Opus" with no channel cap / keep "up to 7.1" (inaccurate for 0x81 layouts) / list both paths (detail belongs in rustdoc).
  • Failing Test (test_testing_clock.py::test_a_pending_timer_waits_for_advance, MoqError.Protocol: old): ✅ treat as a pre-existing flake outside this docs PR / fix it here (unrelated scope). It also failed in the merge queue for moq-dev/moq#5919 and on fix/keylog-opt-in.

Alternatives

Keep valid current source references until hosted API documentation is available, rather than retaining dead links or linking to an older API.

Validation

  • just check on the changed packages (doc site, JS packages) and quest check passed after the merge.
  • Default-feature moq build passed; 34 help contexts and 37 complete supported shell examples checked.
  • External URL audit: 259 checked, 217 successful; verified unavailable references replaced. Crates.io HTML failures are checker behavior, confirmed through its API.
  • Optional-feature CLI builds, GStreamer inspection, and exported-symbol coverage remain for the next audit run (recorded in the quest).

Follow-ups

  • The recurring audit continues in quest/m0/audit-docs.md: exported-symbol and Cross-Package Sync walk, remaining refused links, optional-feature builds. The successor is added once that run completes.
  • The Python test clock flake above deserves its own fix.

(Written by Claude Opus 5.5)

🤖 Generated with Claude Code

kixelated and others added 8 commits October 19, 2026 11:32
Co-Authored-By: GPT-6 <noreply@openai.com>
Co-Authored-By: GPT-6 <noreply@openai.com>
Co-Authored-By: GPT-6 <noreply@openai.com>
Co-Authored-By: GPT-6 <noreply@openai.com>
Co-Authored-By: GPT-6 <noreply@openai.com>
@kixelated

kixelated commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator Author

Checkpoint: concrete fixes are pushed at 23a9ddeec. The default-feature CLI build, 34 help contexts, 37 complete supported examples, stats-doc validator, quest validation, and whitespace checks passed. The audit remains incomplete and the quest stays open. Automatic approval review rejected the full check under shared-host CPU load, and the later load guard stopped before checks began; the latest load was 32.27/22.19/18.17 on 16 cores. Continue with /quest-iterate when resources permit, then finish exported-symbol, sync, optional-feature, and GStreamer verification. There are no open maintainer decisions, public API changes, or wire changes.

(written by GPT-6.1-Sol)

kixelated and others added 2 commits October 19, 2026 17:06
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kixelated
kixelated marked this pull request as ready for review October 20, 2026 00:29
@coderabbitai

coderabbitai Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 27 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bfb6f4d4-5a3c-42e1-83d5-a9a27bd10b74
📥 Commits

Reviewing files that changed from the base of the PR and between 48c8a66 and c2284e9.

📒 Files selected for processing: 13
  • doc/bin/cli.md
  • doc/bin/rtc.md
  • doc/bin/rtmp.md
  • doc/lib/c/index.md
  • doc/lib/js/json.md
  • doc/lib/layers.md
  • doc/lib/py/index.md
  • doc/lib/rs/index.md
  • doc/lib/swift/index.md
  • doc/setup/prod.md
  • js/flate/src/snapshot/consumer.ts
  • js/json/src/snapshot/consumer.ts
  • quest/m0/audit-docs.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-20T00:31:39.179691Z c2284e9 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@kixelated
kixelated added this pull request to the merge queue Oct 20, 2026
Merged via the queue into main with commit 53c2758 Oct 20, 2026
12 checks passed
@kixelated
kixelated deleted the quest/m0/audit-docs branch October 20, 2026 01:50
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.

1 participant