diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 20:43:52 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 20:43:52 +0300 |
| commit | 96e06fadd4790b43f51abaf11e6ec30fa698879f (patch) | |
| tree | 0c1165b9c54d5319093adcc615bf12e14f7c1720 /context7.json | |
| parent | 5c9373d0c6e0457f47a67425285f5a641575fffd (diff) | |
| download | vyos-documentation-96e06fadd4790b43f51abaf11e6ec30fa698879f.tar.gz vyos-documentation-96e06fadd4790b43f51abaf11e6ec30fa698879f.zip | |
docs: address review on context7 rules — op-mode set/add, edit-subtree
Three corrections from Copilot review on #1946:
Rule 2: Mode framing was technically wrong. `set ... ` is not
unique to config mode — op mode has its own `set`/`add` commands
for image management (`add system image`, `set system image
default-boot`). Replace the `set/delete/show` listing with mode
entry mechanics (`configure` enters config; op mode is the default
after login) and acknowledge image-mgmt commands live in op mode.
Rule 8: `add system image` and `set system image default-boot` are
operational-mode commands (verified: docs/installation/update.md
wraps `add system image` in `{opcmd}`; docs/installation/image.md
does the same for `set system image default-boot`). The upgrade
also is not in effect until reboot. Update to: op mode + reboot
to activate.
Rule 10: "Configuration is hierarchical — paths extend without
re-stating it" was misleading. At the top level (just after
`configure`), every `set`/`delete` line must include the full
path. Relative paths only work inside an `edit <subtree>` context.
The original phrasing would have led an LLM to omit parent nodes
and emit invalid CLI examples.
All revised rules verified ≤255 chars.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'context7.json')
| -rw-r--r-- | context7.json | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/context7.json b/context7.json index 3eba41f9..404fe797 100644 --- a/context7.json +++ b/context7.json @@ -24,15 +24,15 @@ ], "rules": [ "Documentation sources are MyST Markdown (.md). Cite and link to the .md form.", - "VyOS has two CLI modes: configuration mode (`set ...`, `delete ...`, `commit`, `save`) and operational mode (`show ...`, `monitor ...`, `restart ...`). Do not mix them.", + "VyOS has two CLI modes: configuration mode (entered via `configure`; uses `set`/`delete`/`commit`/`save`) and operational mode (default after login; uses `show`/`monitor`/`restart`, plus image-mgmt commands like `add system image`). Do not mix.", "Configuration commands are wrapped in `cfgcmd` fenced blocks; operational commands in `opcmd` fenced blocks. Treat these as authoritative command syntax.", "Branch `rolling` tracks the rolling release and the next stable line. Branch `circinus` tracks 1.5.x. Branch `sagitta` tracks 1.4.x. Always cite version-appropriate documentation.", "Do not invent CLI commands. If a command isn't in the docs, say so rather than guess — VyOS syntax is strict and unknown commands fail validation at commit time.", "Use reserved documentation IP space in examples: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24 (RFC 5737), 2001:db8::/32 (RFC 3849). Never use real or RFC1918 addresses.", "`commit` activates pending config and runs validation (errors = no change applied); `save` persists across reboot. `set`/`delete` alone are staged only. Verify with `show <area>` in op mode after commit. Always include both steps in examples.", - "VyOS is image-based, not package-managed. Upgrade with `add system image <url>` then `set system image default-boot <name>`. Do not recommend `apt install` for VyOS components — it bypasses the image system and does not survive reboot.", + "VyOS is image-based, not package-managed. Upgrade in op mode: `add system image <url>`, optionally `set system image default-boot <name>`, then `reboot` to activate. Do not recommend `apt install` for VyOS components — it bypasses the image system.", "Do not recommend raw Linux commands (`ip`, `iptables`, `systemctl`, NetworkManager) for VyOS configuration — they bypass the CLI and do not persist. Use `set/delete/commit/save`. Read-only Linux inspection from op mode is fine.", - "Quote CLI string values that contain spaces or special characters with single quotes (e.g. `set system host-name 'edge-01'`). Configuration is hierarchical — paths under a parent (e.g. `set firewall name FOO rule 10`) extend without re-stating it.", + "Quote CLI strings containing spaces or special chars with single quotes (e.g. `set system host-name 'edge-01'`). Top-level `set`/`delete` lines must include the full path; relative paths only work inside an `edit` subtree (e.g. `edit firewall name FOO`).", "Routing protocols (BGP, OSPF, IS-IS, RIP) are FRR-backed, but not every FRR knob is exposed through the VyOS CLI. Confirm a command exists in the VyOS docs before suggesting it — synthesizing from FRR documentation produces invalid VyOS commands." ], "previousVersions": [ |
