From fe25c65475b273f31968dcee63b42829150b19f0 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sun, 10 May 2026 13:23:32 +0300 Subject: Enrich context7.json with project metadata, scope, and rules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- context7.json | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) 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" } + ] } -- cgit v1.2.3