From d71fc51ee02595c1a3cd08dd398e60638e1d2e1c Mon Sep 17 00:00:00 2001 From: Pedro Henrique Penna Date: Sat, 10 Oct 2026 13:09:42 -0300 Subject: [PATCH] doc: link the OpenVMM upstream roadmap from the documentation index doc/openvmm-upstream-roadmap.md was not linked from README.md or any other document, so readers could reach it only by browsing doc/. Index it in the README's Development list, and point to it from the contributing guide's OpenVMM source-change section, which now also states that nanvix/openvmm is a fork of microsoft/openvmm. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 2 ++ doc/contribute.md | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index bc59b6aee..7dcd0bac8 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,5 @@ python scripts\nvx.py run - [Package and source delivery](doc/distribution.md) - Instructions for packaging and distributing NVX. - [Contributing](doc/contribute.md) - Guidelines for contributing to NVX. +- [OpenVMM upstream roadmap](doc/openvmm-upstream-roadmap.md) - Plan for upstreaming the OpenVMM + fork's microVM commits. diff --git a/doc/contribute.md b/doc/contribute.md index 278316fe6..e7b27cb60 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -126,6 +126,12 @@ Change OpenVMM through a pull request to `nanvix/openvmm` that follows including their Clippy, rustdoc, test, and formatting checks, then promote the reviewed revision into NVX. +`nanvix/openvmm` is a fork of +[microsoft/openvmm](https://github.com/microsoft/openvmm). The +[OpenVMM upstream roadmap](openvmm-upstream-roadmap.md) groups the fork's +microVM commits into planned upstream pull requests and marks those that stay +fork-only. + ### Pin promotion A pin promotion moves the `openvmm` gitlink to a reviewed OpenVMM revision: