Repository navigation
doc: list the environment bootstrap files in the source tree - #510
Merged
Pedro Henrique Penna (ppenna) merged 2 commits intoOct 12, 2026
Merged
Conversation
Expand the setup directory in the source-tree guide so contributors can find the platform-specific host and Actions runner scripts and their shared tool release/checksum manifest. Link directly to the tracked manifest while leaving setup procedures in the setup guide. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation is accurate; only a minor alignment nit remains.
1 open finding
What changed in this PR
Expands the repository guide to document environment bootstrap files.
Changes:
- Lists platform-specific bootstrap scripts and the shared tool manifest.
- Links directly to the tool manifest.
| File | Description |
|---|---|
doc/project-structure.md |
Documents bootstrap files and manifest. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Pedro Henrique Penna (ppenna)
deleted the
doc-sync/bootstrap-source-tree
branch
October 12, 2026 19:06
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.

Summary
Expand the previously collapsed
scripts/setup/entry in thesource-tree guide
so new contributors can find the platform-specific bootstrap scripts and their
shared tool-version manifest.
This deliberately fills one small gap in the tracked-layout map rather than
duplicating setup procedures or changing provisioning behavior. Only one
Markdown file changes: five added lines and one removed.
Comparison base:
origin/devat9a2721a713a1bb78f0c94c189900cf89a728a26e.Changes
scripts/setup/setup-linux-mshv.shdescribes its existing-checkout Linux/MSHV role in its usage text.scripts/setup/setup-linux-runner.shnames both backends and its runner registration options.scripts/setup/setup-windows-whp.ps1enables WHP and distinguishes normal host setup from-RunnerOnlyprovisioning.scripts/setup/tool-versions.confcontains the releases, artifact names, and SHA-256 pins read by the setup scripts.git ls-files -- scripts\setupconfirms that all four entries are tracked.No version numbers or setup instructions are copied into the source-tree guide.
No design documents, implementation, CI definitions, performance data, or
OpenVMM gitlink changed.
Follow-ups
Relocate the
bootstrap guide
into
doc/in a later run. Its incoming links inthe setup guide
and the CI guide
overlap open PRs #405 and #406, so this run conservatively leaves those files
alone.
Validation
python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests:passed, 117 tests with one Windows skip (
needs a Linux pseudo-terminal).anchors in the changed guide, its incoming-link file (
README.md), and thedesign index; confirmed one H1 and balanced code fences in the changed file,
and links to all 16 chapters under
doc/design/.git diff --check: passed.python scripts\nvx.py verify: passed before and after the documentationchange. Checked-out OpenVMM matches the pinned
2130f24b5a51561cc6224fe5a0aff93cb121ac32.every added entry verified against source, and no files touched by open PRs.
git verify-commit HEAD: passed using the repository's signing configuration.0/0.No build or hypervisor runs are claimed or needed for this documentation-only
change.