microsoft/openvmm
Publicmirrored fromhttps://github.com/microsoft/openvmmAvailable
.github/instructions/doc-code-sync.instructions.md
21lines · modecode
| 1 | --- |
| 2 | applyTo: "**/*.rs,**/Cargo.toml" |
| 3 | --- |
| 4 | |
| 5 | # Documentation Sync |
| 6 | |
| 7 | If a PR makes a structural change — new feature, renamed concept, changed CLI |
| 8 | flag, new device or backend type — check whether the |
| 9 | [OpenVMM Guide](https://openvmm.dev) (`Guide/src/`) covers that topic. If it |
| 10 | does, the PR should update the Guide or flag a follow-up. |
| 11 | |
| 12 | ## Quick heuristics |
| 13 | |
| 14 | - CLI args changed in `openvmm_entry` → `Guide/src/reference/openvmm/management/cli.md` |
| 15 | - Device crate under `vm/devices/` changed → look for a matching page under `Guide/src/reference/` |
| 16 | - OpenHCL internals changed (`openhcl/`) → `Guide/src/reference/architecture/openhcl/` |
| 17 | - Crate renamed or moved → grep `Guide/src/` for the old name |
| 18 | - New crate under `vm/devices/` → consider whether it needs a reference page |
| 19 | |
| 20 | For the full code-to-Guide mapping and maintenance procedures, load the |
| 21 | **`guide-maintenance`** skill. |
| 22 | |