| Age | Commit message (Collapse) | Author |
|---|
|
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 <area>` was hand-wavy and arguably invented syntax β
conflicts with rule 5 ("do not invent CLI commands"). Replace with
documented forms: `show <node>` (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)
|
|
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)
|
|
Add 5 rules to `context7.json` targeting recurring LLM mistakes when
answering VyOS questions through the context7-served index:
1. `commit` vs `save` semantics + verification step. Most common
mistake: forgetting that `set/delete` are staged-only, that
`commit` runs validation (failure = no change), and that `save`
is a separate persistence step.
2. Image-based, not package-managed. Stops `apt install <pkg>`
recommendations. Upgrade is `add system image <url>` then
`set system image default-boot <name>`.
3. No raw Linux commands for configuration (`ip`, `iptables`,
`systemctl`, NetworkManager). They bypass the CLI and do not
persist.
4. CLI quoting with single quotes for whitespace/special chars +
hierarchical-path reminder (paths under a parent extend without
re-stating it).
5. Routing protocols are FRR-backed but only the VyOS-CLI-exposed
subset is valid. Synthesizing from FRR docs produces invalid
VyOS commands. Reinforces existing rule 5 with the most common
synthesis trap.
Each rule fits the 255-char per-rule limit. Total now 11 of 50.
Lower-priority candidates intentionally omitted (low LLM-mistake
yield): `compare`/`discard`/`rollback` mechanics, interface naming
conventions, `commit-confirm`, `load`/`merge`, Equuleus EOL
status β already implicit in the version-branches rule.
π€ Generated by [robots](https://vyos.io)
|
|
The swap mechanism (RST-as-fallback for migrated MD pages) is dormant β
docs/_rst_overrides.txt has been empty since the MyST flip trio
(#1899/#1900/#1901) landed in May 2026. The mechanism's surface area
(scripts/swap_sources.py, its 245-line test, RTD pre/post hooks,
Makefile glue, conf.py dynamic loader) is dead weight, and the
rst-*.rst shadows scattered across the source tree cause Context7's
parser to misclassify the project as RST.
Changes:
- Move 253 rst-*.rst shadow files into docs/_rst_legacy/ preserving
subdirectory structure. They remain in the repo for reference; Sphinx
excludes the folder via exclude_patterns; Context7 excludes it via
excludeFolders.
- Strip swap_sources.py invocation from docs/Makefile (swap/restore
targets, : swap deps, trap chains).
- Strip jobs: pre_build/post_build block from .readthedocs.yml.
- Strip rst-*.rst exclude entry and the _md_exclude.txt loader from
docs/conf.py; replace with a single _rst_legacy exclude.
- Delete scripts/swap_sources.py, tests/test_swap_sources.py,
docs/_rst_overrides.txt.
- Update context7.json: add docs/_rst_legacy to excludeFolders;
fix stale "Branch current tracksβ¦" rule to "Branch rolling tracksβ¦"
(default branch was renamed 2026-05-10).
- Update AGENTS.md: drop the "RST override mechanism" section and the
test-runner snippet for the deleted test; describe _rst_legacy as
archive only.
Verified: sphinx-build -b html with --keep-going produces identical
warning set (68 unique), identical sitemap entry count (257), identical
llms.txt entry count (22), zero rst-* URLs in any artifact.
π€ Generated by [robots](https://vyos.io)
|
|
context7.json now references the floating release tags (1.5, 1.4)
created by .github/workflows/update-version-tags.yml instead of the
internal branch names (circinus, sagitta). The tags are kept at the
HEAD of their corresponding branches by the workflow, so consumers
get the same content under stable, version-shaped names.
π€ Generated by [robots](https://vyos.io)
|
|
Adds the optional schema fields documented at
https://context7.com/docs/adding-libraries to give the Context7 indexer
clearer guidance:
- projectTitle / description: stable display strings instead of LLM
guesses on every refresh.
- folders / excludeFolders / excludeFiles: limit indexing to docs/ and
skip build artifacts, support scripts, and meta files.
- rules: surface the conventions LLMs should respect when answering
from VyOS docs β CLI mode separation, cfgcmd/opcmd authority,
per-branch version mapping, no-invented-commands, and reserved
documentation address space.
- previousVersions: map circinus (1.5.x) and sagitta (1.4.x) so
Context7 can serve version-appropriate answers.
π€ Generated by [robots](https://vyos.io)
|
|
Allows the repo owner to manage Context7 indexing settings (refresh
cadence, exclusions, branding) for https://context7.com/vyos/vyos-documentation.
π€ Generated by [robots](https://vyos.io)
|
