doc: link the OpenVMM upstream roadmap from the documentation index

[Pedro Henrique Penna (ppenna)]

Summary

doc/openvmm-upstream-roadmap.md was an orphan: no document linked to it, and the README's documentation index omitted it (it appeared only as plain text in the doc/project-structure.md tree). This PR indexes it from the README and points to it from the contributing guide's OpenVMM section, where contributors changing OpenVMM look for how the fork relates to upstream.

Changes

• README.md: add OpenVMM upstream roadmap to the Development list.
  • Evidence: rg openvmm-upstream-roadmap.md doc README.md found no Markdown link to the file before this change.
• doc/contribute.md (OpenVMM > Source changes): state that nanvix/openvmm is a fork of microsoft/openvmm, and that the roadmap groups the fork's microVM commits into planned upstream pull requests and marks fork-only ones.
  • Fork relationship: gh api repos/nanvix/openvmm --jq '.fork, .parent.full_name' returns true / microsoft/openvmm.
  • Roadmap content: its Legend classes N and F mark fork-only commits, and its PR graph and commit-to-PR mapping cover the microVM commits. Its fork base e1cdbd916 is an ancestor of the pinned revision, 305 commits back (166 mapped + 139 after the mapped tip, matching the roadmap's Scope).

No design chapter changed. For reference, the pinned OpenVMM revision is 7bf0ee28b826374a2d386067df0456b81bcae818.

The roadmap file itself is touched by open PR #475, so this PR leaves it alone and only adds links to it.

Follow-ups

• scripts/setup/README.md is a guide outside doc/. scripts/test_tool_versions.py reads it in place, and scripts/setup/tool-versions.conf refers to it as the README next to the scripts, so moving it would need code and test changes. I left it in place.
• unittest_results.txt is tracked at the repository root and looks like an accidentally committed test log. It's not Markdown, so it's out of scope here.
• python scripts/nvx.py --help still describes init as "initialize the private submodule", but the OpenVMM submodule is public (see doc/contribute.md#access). This is a code help string, so I'm reporting it rather than changing it.
• doc/design/time-abi.md is about 170 KB, far longer than the other chapters. It's touched by open PRs test-microvm: pause and resume a microVM through OpenVMM state control #405 and Adopt bind-once microVM image slots #406, so I left it alone.

Validation

• python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests: Ran 110 tests, OK (skipped=1).
• A throwaway checker kept outside the repo checked 9 files (the changed files and every Markdown file that links to them). Every relative link and anchor resolves, each changed file has one H1 and balanced code fences, and doc/design.md links every chapter in doc/design/. Result: OK.
• git diff --check: clean.
• python scripts/nvx.py verify: source tree and submodule metadata are consistent.
• Every changed path matches ^(doc/|.*\.md$), so CI treats this PR as documentation-only.

[Copilot]

🟢 Approval recommended

Both links resolve correctly and accurately describe the roadmap.

0 open findings

What changed in this PR

Indexes the OpenVMM upstream roadmap so contributors can discover the fork’s upstreaming plan.

Changes:

• Adds the roadmap to the main documentation index.
• Links and explains it in the OpenVMM contribution guide.

File	Description
README.md	Adds the roadmap to Development documentation.
doc/​contribute.md	Documents the fork relationship and roadmap purpose.

🧠 Review effort: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.