Repository navigation
docs: finish the m1 documentation audit #6170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
0cf25c4
quest: claim m1/audit-docs
kixelated cb315ed
docs(readme): fix the demo port and the moq-tokio and moq-mux rows
kixelated 1aee419
docs(concept): https:// dials WebTransport, and WebSocket rides eithe…
kixelated 14371c7
docs(bin): fix the RTMP FLAC reason and add Opus to SRT's codecs
kixelated 52b6745
docs(moq-c): ranges are a per-subscription read filter
kixelated 8e2572c
chore(shaper): lint missing docs
kixelated 099c73c
docs(wasm): document Group.sequence and lint missing docs
kixelated 5a839ee
quest: finish the m1 documentation audit and add the m2 run
kixelated d70c259
Merge remote-tracking branch 'origin/main' into merge-6170
kixelated cd40579
docs: point the demo URL at watch.html
kixelated File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # [M] Documentation audit | ||
|
|
||
| ## Goal | ||
|
|
||
| Docs match the code: stale pages, broken examples, broken links, and | ||
| undocumented exported symbols are fixed or planned. | ||
|
|
||
| ## Plan | ||
|
|
||
| Recurs once per major release (decided 2026-10-19). The PR that finishes | ||
| this run also adds the next one with the same file name at the end of the next | ||
| milestone's `Required` (m0 to m1, m1 to m2). The successor keeps the Goal | ||
| and this paragraph; the rest of its Plan is rewritten with what this run | ||
| learned: baselines, results, and what to check first. A successor placed in m2 | ||
| also lists the [release cut](/quest/m2/release/cut.md) under `Required`, so it | ||
| waits for the release in flight to ship. Only `/quest-delete` ends the | ||
| recurrence. Fixes land in the run's PR, one commit each, rather than as follow-ups. | ||
| Only a change that needs a maintainer decision (public API, scope) or is | ||
| independently landable and too large to review alongside the rest becomes a | ||
| follow-up through `/quest-plan`. | ||
|
|
||
| Follow `doc/AGENTS.md` for what belongs in `doc/`. The docs site deploys from | ||
| `release`, so a page describing an unreleased package (such as `@moq/video`, | ||
| first published by the release cut) is expected to 404 on its registry until | ||
| then. The m1 run (2026-10-21) found the stale claims in pages no PR had touched | ||
| for a while: the root `README.md` crate table, `doc/concept/transport.md`, and | ||
| the codec lists in `doc/bin/rtmp.md` and `srt.md`. Read those kinds of pages | ||
| claim by claim against the code first; the pages recent PRs edit are the | ||
| freshest. Baselines: | ||
|
|
||
| - Rust: 28 crates set `#![warn(missing_docs)]`; m1 added `moq-shaper` and | ||
| `moq-wasm`. Count the rest with | ||
| `cargo rustdoc -p <crate> --lib --all-features -- -W missing_docs`, and | ||
| `moq-wasm` with `--target wasm32-unknown-unknown`, since it is empty on | ||
| native. `moq-auth` is ambiguous with its crates.io copy, so pass its | ||
| `path+file://` spec. Every linted crate was clean with all features. | ||
| `moq-audio`, `moq-video`, and `moq-sock` were also clean on Linux but stay | ||
| unlinted for their macOS, Windows, and Android items. `moq-gst` has 3 items | ||
| from `gst::plugin_define!`. `moq-v4l` reports 3108, nearly all its generated | ||
| `sys` bindings; whether the fork earns docs is still undecided. `moq-mux`, | ||
| `moq-ffi`, and `moq-c` had follow-ups in flight | ||
| ([docs-mux](https://github.com/moq-dev/moq/pull/6088), | ||
| [docs-bindings](https://github.com/moq-dev/moq/pull/6091)); check that they | ||
| landed and set the lint. | ||
| - JS: since [docs-js](https://github.com/moq-dev/moq/pull/6163), every | ||
| published package's build runs `js/common/docs.ts`, which fails on an | ||
| undocumented export or public class member, so check only that its | ||
| exemptions (private, protected, symbol brands, and custom element reactions) | ||
| still hold up and that docs say something. | ||
| - Links: GET (not HEAD) every external URL in `doc/` with a browser user | ||
| agent. 316 URLs: all answered except placeholder and local hosts, relay | ||
| URLs that only speak MoQ, npmjs.com and w3.org pages that refuse | ||
| non-browser clients, and the unreleased items above. Check npm packages on | ||
| `registry.npmjs.org/<package>` and crates on the crates.io API, since | ||
| crates.io pages answer 200 to anything. `README.md`'s `moq-c` badge waits on | ||
| the crate's first publish. | ||
| - CLI: all 68 shell invocations in `doc/`, `README.md`, and | ||
| `rs/moq-cli/README.md` parse with `--help` appended against a build with | ||
| `capture,play,transcode,iroh,openh264`, after substituting a URL for the | ||
| elided `moq ...` connect. Unknown flags fail but bad values do not. | ||
| `gst-inspect-1.0` of a debug `moq-gst` build lists every element and pad | ||
| property `doc/bin/gstreamer.md` names. | ||
| - Cross-Package Sync: walked from `9b90cdd569` through `7d2a91fe66`. Walk the | ||
| next run from there. Go has no `Client` failure accessor because `Dial` | ||
| returns only once connected; the maintainer chose to leave that until a Go | ||
| caller needs it, so it is not a gap. | ||
|
|
||
| ## Required | ||
|
|
||
| - [Release cut](/quest/m2/release/cut.md) - the release in flight ships before this run starts | ||
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the Goal require corrected documentation.
The
or plannedclause allows this quest to finish while stale documentation remains. This conflicts with line 17, which requires fixes to land in this run except for the explicit follow-up cases. State the corrected documentation as the Goal outcome. Keep baselines and follow-up status inPlan.Based on learnings, the Goal should state the outcome the quest establishes, not its current status.
Proposed wording
📝 Committable suggestion
🤖 Prompt for AI Agents
Source: Learnings