[Pedro Henrique Penna (ppenna)]

Fixes #999.
Fixes #1003.

RUSTDOCFLAGS="-D warnings" cargo doc --no-deps fails for the runtime adapter in every one of its configurations, and CI never builds the adapter's documentation, so nothing caught it. This fixes the links that break it and adds the check to check-nvx-rs.

Problem and root cause

• Unresolved links to Runner, in all three configurations. tests/runtime-adapter/src/exec.rs links [`Runner`] in its module documentation and in GuestMessage's, and [`Runner::next_message`] in GuestMessage::from_runner's, but its code imports only the module nvx::exec::runner; only src/worker/executions.rs imports Runner. They have failed since 3322870 (tests: run executions in the runtime adapter through the shared engine #784).
• Links to private items, in the guest-only configuration, found while reproducing. The documentation of the public module worker::mapping links to its private constants WRITTEN_FILE and WRITTEN, which rustdoc's private_intra_doc_links lint reports, since 47f8bcd (tests: map the host's mapping tables in the adapter's VMs #878). runtime-adapter: rustdoc fails on unresolved links to Runner in src/exec.rs #999 doesn't list them because only --features guest --target x86_64-unknown-linux-musl builds that module; runtime-adapter: rustdoc fails on private-item links in src/worker/mapping.rs #1003, filed since, reports them.
• No check in CI. check-nvx-rs builds nvx-rs's documentation with warnings denied, but not the adapter's.

Reproduced on Windows at BASE e24fd5757, in tests/runtime-adapter with RUSTDOCFLAGS="-D warnings":

Configuration	cargo doc --locked --no-deps ...	BASE	Head
protocol-only	(no options)	3 errors: exec.rs:3, :483, :502	passes
host-only	--features host	the same 3 errors	passes
guest-only	--features guest --target x86_64-unknown-linux-musl	the same 3, and 2 in worker/mapping.rs:14	passes

Change

Commit	Files	Change
20df05aba runtime-adapter	tests/runtime-adapter/src/exec.rs	Points the three links at nvx::exec::Runner, as the adapter's other links to nvx's items, such as [`ErrorKind::Io`](nvx::ErrorKind::Io), already do. nvx::exec holds the execution engine in every configuration of nvx, so they resolve in each of the adapter's. Importing Runner instead would warn as an unused import.
e91b8fc2b runtime-adapter	tests/runtime-adapter/src/worker/mapping.rs	States the map probe's file and contents, written and runtime-adapter, instead of linking to the private constants, in the words of the README's table of probes, and as the module already names its other constants' values.
9de096597 ci	.github/actions/check-nvx-rs/action.yml, scripts/test_nvx_tools.py, doc/ci.md, doc/contribute.md, tests/runtime-adapter/README.md	Each of the adapter's three configuration steps runs RUSTDOCFLAGS="-D warnings" cargo doc --locked --no-deps with its features and target, after its tests and before the MSRV check. RUSTDOCFLAGS is set for that command alone, so that it doesn't reach the doctests that cargo test compiles. test_nvx_rs_checks_the_runtime_adapter_in_each_configuration requires the command in each step, and fails for all three against the action without it. The docs list the check, and the README gives its commands.

Two choices that the issue left open, decided conservatively:

• The issue said to consider the CI check. It is this fix's regression test: without it, the next unresolved link reaches dev the same way.
• The private links are reworded rather than made public, which would add the constants to the adapter's API only to serve the documentation.

Validation

BASE: dev at e24fd5757. dev has since moved to 24c037003, by data: commits only, which touch none of these files.

Local, on Windows:

• Each commit, with git rebase -x: cargo fmt --all --check and the protocol-only and host-only documentation with warnings denied in tests/runtime-adapter, the narrow test above, and python scripts/check_markdown_links.py, all clean. The guest-only documentation passes from e91b8fc2b on, whose adapter sources the last commit leaves unchanged; 20df05aba leaves it failing on the private links, as its message says.
• The protocol-only and host-only steps of check-nvx-rs, extracted from the action and run in Git Bash with the pinned toolchain (1.95.0) and the MSRV (1.89): fmt, Clippy, build, tests (protocol-only 47 passed; host-only 103 passed, 58 VM tests ignored), documentation, and the MSRV check, all clean.
• The guest-only step's Clippy, documentation, and MSRV check for x86_64-unknown-linux-musl, all clean.
• runtime-adapter: rustdoc fails on private-item links in src/worker/mapping.rs #1003's command, RUSTDOCFLAGS="-D warnings" cargo doc --locked --no-deps --features guest --target x86_64-unknown-linux-musl in tests/runtime-adapter, run again on 2026-10-29: at dev 24c037003 it fails with the five errors above, including src/worker/mapping.rs:14 for WRITTEN_FILE and WRITTEN; at head 9de096597 it passes without a warning.
• check-quality: Ruff lint and format, Pyright for Linux and Windows (0 errors), and the Markdown link check.
• validate-nvx: compileall, test_adversarial.py, test_hosts.py, and the help commands pass. The unittest list ran 1431 tests with 18 failures, all in scripts/test_setup_azure.py, which fails identically at BASE on this machine: its bash is WSL's launcher, which can't read the tests' Windows temporary paths. The list passes on Linux, below.

Hosts:

Profile	Backend	Host type	Test	Result
nvx-kvm-test	kvm (no VM booted)	virtual-machine	The guest-only step's build, tests, and documentation with warnings denied, for x86_64-unknown-linux-musl	Pass: 67, 61, and 8 tests passed
nvx-kvm-test	kvm (no VM booted)	virtual-machine	The validate-nvx unittest list on Linux	Pass: 1431 tests, 30 skipped

CI, run 40836542861, attempt 1, at head 9de0965975c3776423153b0a16cd85e7145426ea: passed, with Required status check.

• nvx-rs / ubuntu-latest ran the new documentation command in all three of the adapter's configurations, and nvx-rs / windows-latest in the protocol-only and host-only ones, each without a warning. The Ubuntu job also ran the guest-only step's Clippy and MSRV check, which the host's toolchains lack, so they ran on Windows for the same target before.
• The NVX microVM jobs that the change classification selects for an adapter change passed on Linux/KVM, Linux/MSHV, and Windows/WHP, the runtime adapter's VM suites included. The adapter's changes are documentation comments only, so no VM was booted for this pull request outside CI.

Follow-ups

• scripts/test_setup_azure.py fails on a Windows machine whose bash on PATH is WSL's launcher rather than Git Bash, as it does at BASE; CI's Windows runners use Git Bash. Not changed here.

[Copilot]

🟢 Approval recommended

No active review issues are recorded for the rustdoc-link fixes and added documentation checks.

No open issues 🎉

What changed in this PR

Fixes #999 by repairing the runtime adapter’s rustdoc links and adding documentation checks to the existing Rust CI action. Runtime behavior is unchanged.

Changes:

• Qualifies links to Runner and replaces links to private mapping constants with their documented values.
• Builds documentation with warnings denied for protocol-only, host-only, and guest-only configurations.
• Extends the CI regression test and updates contributor documentation and local validation commands.

File	Description
tests/​runtime-adapter/​src/​worker/​mapping.rs	Replaces private-item documentation links with literal values.
tests/​runtime-adapter/​src/​exec.rs	Qualifies three rustdoc links to Runner.
tests/​runtime-adapter/​README.md	Adds documentation validation commands.
scripts/​test_nvx_tools.py	Requires documentation checks in all three configuration steps.
doc/​contribute.md	Lists rustdoc among the adapter’s required checks.
doc/​ci.md	Documents the new adapter documentation checks.
.github/​actions/​check-nvx-rs/​action.yml	Builds adapter documentation with command-scoped warning denial.

_{Review effort: Balanced}