From e5105c905e6bb4c0bdc2f4435687437c78fd27ad Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sun, 10 May 2026 21:48:58 +0300 Subject: docs: address review on context7 rules — show in both modes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two more corrections from Copilot review on #1946: Rule 2: `show` exists in both modes. Config-mode `show` displays the working config (verified: `docs/cli.md:389` wraps `show` in `{cfgcmd}`). Op-mode `show` displays running state. Previous wording listed `show` under operational mode only, which contradicted `cli.md`. Reframe to list `show` in both, scoped to "config-state" vs running state. Rule 7: `show ` was hand-wavy and arguably invented syntax — conflicts with rule 5 ("do not invent CLI commands"). Replace with documented forms: `show ` (config mode, verified at `docs/cli.md:389`) or `show configuration commands` (op mode, verified at `docs/cli.md:224`). Both are direct quotes from the canonical CLI reference. 🤖 Generated by [robots](https://vyos.io) --- context7.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'context7.json') diff --git a/context7.json b/context7.json index 404fe797..804004b2 100644 --- a/context7.json +++ b/context7.json @@ -24,12 +24,12 @@ ], "rules": [ "Documentation sources are MyST Markdown (.md). Cite and link to the .md form.", - "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.", + "VyOS has two CLI modes: configuration mode (entered via `configure`; for `set`/`delete`/`commit`/`save` and config-state `show`) and operational mode (default after login; for `show`, `monitor`, plus image-mgmt 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 ` in op mode after commit. Always include both steps in examples.", + "`commit` activates pending `set`/`delete` changes and runs validation (errors = no change applied); `save` persists across reboot. Verify with `show ` (config mode) or `show configuration commands` (op mode). Always include `commit` and `save`.", "VyOS is image-based, not package-managed. Upgrade in op mode: `add system image `, optionally `set system image default-boot `, 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 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`).", -- cgit v1.2.3