diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 13:27:06 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-10 13:27:06 +0300 |
| commit | 4b61f4d61dc916cd076bccda6da2cd73f8e9dea2 (patch) | |
| tree | 32ca354189af52209a12c4f6521736416bbd06e1 /context7.json | |
| parent | acb2bea46b67392603b8cb198694420e9e26015e (diff) | |
| parent | fe25c65475b273f31968dcee63b42829150b19f0 (diff) | |
| download | vyos-documentation-4b61f4d61dc916cd076bccda6da2cd73f8e9dea2.tar.gz vyos-documentation-4b61f4d61dc916cd076bccda6da2cd73f8e9dea2.zip | |
Merge pull request #1933 from vyos/yuriy/context7-enrich
Enrich context7.json with project metadata, scope, and rules
Diffstat (limited to 'context7.json')
| -rw-r--r-- | context7.json | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/context7.json b/context7.json index b4d3f96d..92eea80b 100644 --- a/context7.json +++ b/context7.json @@ -1,4 +1,36 @@ { + "$schema": "https://context7.com/schema/context7.json", + "projectTitle": "VyOS Networking Platform", + "description": "VyOS, Enterprise-Grade Open Source Networking Platform for Bare Metal, Cloud, and Edge", "url": "https://context7.com/vyos/vyos-documentation", - "public_key": "pk_CL1d8D3hhCrefEKCC4K8L" + "public_key": "pk_CL1d8D3hhCrefEKCC4K8L", + "folders": ["docs"], + "excludeFolders": [ + "docs/_build", + "docs/_static", + "docs/_templates", + "docs/_ext", + "scripts", + "tests", + ".github", + "node_modules" + ], + "excludeFiles": [ + "CHANGELOG.md", + "LICENSE", + "CODE_OF_CONDUCT.md", + "CONTRIBUTING.md" + ], + "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.", + "Configuration commands are wrapped in `cfgcmd` fenced blocks; operational commands in `opcmd` fenced blocks. Treat these as authoritative command syntax.", + "Branch `current` tracks the rolling release and the next stable line (1.5+). 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." + ], + "previousVersions": [ + { "branch": "circinus" }, + { "branch": "sagitta" } + ] } |