Repository navigation
doc: list the agent backend and Azure Linux chapter in the source tree - #466
Merged
Pedro Henrique Penna (ppenna) merged 1 commit intoOct 10, 2026
Merged
Conversation
The project structure guide predates the opt-in agent backend of aci_edge_sandboxes and the Azure Linux guest chapter. Add src/agent/, the agent_lifecycle example, and the agent-library and validation tests to the crate's entry, and name both guest chapters under doc/guests/. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Pedro Henrique Penna (ppenna)
October 10, 2026 04:07
View session
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation accurately reflects the corresponding source tree, features, examples, and tests.
0 open findings
What changed in this PR
Updates the repository structure guide to reflect existing guest documentation and the opt-in native-agent backend.
Changes:
- Adds Azure Linux to the guest documentation listing.
- Documents the agent backend, example, and associated tests.
- Clarifies the crate’s dual-backend architecture.
| File | Description |
|---|---|
doc/project-structure.md |
Synchronizes the documented tree and backend overview with tracked sources. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pedro Henrique Penna (ppenna)
deleted the
doc-sync/project-structure-edge-sandboxes
branch
October 10, 2026 04:20
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
doc/project-structure.mdpredates two additions to the tracked tree: the opt-in native-agent backend of theaci_edge_sandboxescrate (added in 2113c65) and the Azure Linux guest chapter indoc/guests/. This PR brings the source-tree guide back in line withgit ls-files. It changes documentation only.Base:
origin/devat524a62699fb1607fd299f9995b846508cd49d656. No design chapter changed, so the OpenVMM pin (e5bf79776bb32f8fa29a69e7b3c9bf668477a13a) was not consulted for claims.Changes
doc/guests/entrygit ls-files doc/guestslistsazurelinux-guest.mdandubuntu-guest.mdaci_edge_sandboxes/src/subtreeopenvmm/andbin/onlyagent/, an opt-in backend over a separately supplied native agent librarygit ls-files aci_edge_sandboxes/src/agent;aci_edge_sandboxes/src/agent/mod.rsmodule docs; theagentfeature inaci_edge_sandboxes/Cargo.tomlexamples/entry[[example]]entrieslifecycle(featureopenvmm) andagent_lifecycle(featureagent) inaci_edge_sandboxes/Cargo.tomltests/entryaci_edge_sandboxes/tests/validation.rsandtests/agent_guest.rsmodule docsaci_edge_sandboxes/sectionagentfeature's backend, a thin client of a native library that owns the sandbox lifecycleaci_edge_sandboxes/Cargo.tomlfeature comment;aci_edge_sandboxes/README.mdArchitecture sectionFollow-ups
Left out of scope; not changed here:
scripts/setup/README.mdis documentation outsidedoc/. Moving it needs link updates indoc/ci.mdanddoc/setup.md, which open PRs filesystem: map host paths from any volume, each with its own access #459, Adopt bind-once microVM image slots #406, and test-microvm: pause and resume a microVM through OpenVMM state control #405 touch, so the relocation should wait until they land.unittest_results.txtis a tracked unit-test log at the repository root, present since the initial commit. It looks like a stray artifact. This PR leaves it undocumented; removing it is a code-owner decision.python scripts/nvx.py --helpstill describesinitas "initialize the private submodule", but the OpenVMM submodule is public (seedoc/contribute.md#access). That is help text in code, so it is reported here rather than changed.doc/openvmm-upstream-roadmap.mdrecords fork and upstream SHAs as of 2026-10-01, and OpenVMM pins have moved several times since. Refreshing it needs a full fork-history analysis.Validation
python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests: Ran 110 tests, OK (skipped=1)doc/project-structure.mdand the files that link to it. The file has one H1 and balanced code fences, anddoc/design.mdlinks every chapter indoc/design/. Result: OKgit diff --check: cleanpython scripts\nvx.py verify: source tree and submodule metadata are consistent^(doc/|.*\.md$), so CI classifies the PR as documentation-only.