diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 09:51:18 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-07 09:51:18 +0300 |
| commit | a7bb8246e42719a809421d016f8f5d52f43d7db1 (patch) | |
| tree | 66f069575bdaf0ad02b3dfaed5a53965e09021aa /docs/_templates | |
| parent | 7cf51e1c2901f6d1b01e9bff194f7188bc29e417 (diff) | |
| parent | 04541bda8a3d04ecb9824f92d344ec8bd7aa2523 (diff) | |
| download | vyos-documentation-a7bb8246e42719a809421d016f8f5d52f43d7db1.tar.gz vyos-documentation-a7bb8246e42719a809421d016f8f5d52f43d7db1.zip | |
Merge pull request #1874 from vyos/feat/docs-llms-txt-current
docs: render llms.txt at build time (current)
Diffstat (limited to 'docs/_templates')
| -rw-r--r-- | docs/_templates/llms.txt.j2 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/_templates/llms.txt.j2 b/docs/_templates/llms.txt.j2 new file mode 100644 index 00000000..1c6a3900 --- /dev/null +++ b/docs/_templates/llms.txt.j2 @@ -0,0 +1,52 @@ +# VyOS + +> VyOS is a free, open-source network operating system based on Debian GNU/Linux. +> It provides routing, firewall, and VPN functionality via a unified CLI using +> `set`/`delete`/`show` command hierarchy. This documentation covers {{ release }}. + +VyOS configuration follows a tree structure. All configuration commands start with +`set` (to add/change) or `delete` (to remove). Changes are staged and applied with +`commit`. The CLI hierarchy maps directly to the documentation structure. + +## Quick Start + +- [Quick Start Guide]({{ baseurl }}quick-start.md): Minimal setup walkthrough +- [CLI Overview]({{ baseurl }}cli.md): Command-line interface usage + +## Configuration + +- [Firewall]({{ baseurl }}configuration/firewall/index.md): Zone-based firewall, rules, groups +- [Interfaces]({{ baseurl }}configuration/interfaces/index.md): Ethernet, bonding, bridge, VLAN, tunnel, wireless +- [Protocols]({{ baseurl }}configuration/protocols/index.md): BGP, OSPF, IS-IS, static routing, MPLS +- [VPN]({{ baseurl }}configuration/vpn/index.md): IPsec, OpenVPN, WireGuard, L2TP, PPTP +- [NAT]({{ baseurl }}configuration/nat/index.md): Source NAT, destination NAT, NAT66 +- [System]({{ baseurl }}configuration/system/index.md): DNS, NTP, syslog, users, task scheduler +- [High Availability]({{ baseurl }}configuration/highavailability/index.md): VRRP +- [Load Balancing]({{ baseurl }}configuration/loadbalancing/index.md): WAN and reverse proxy +- [Containers]({{ baseurl }}configuration/container/index.md): Podman-based container support +- [PKI]({{ baseurl }}configuration/pki/index.md): Certificate management +- [Policy]({{ baseurl }}configuration/policy/index.md): Route maps, prefix lists, access lists +- [Traffic Policy]({{ baseurl }}configuration/trafficpolicy/index.md): QoS and shaping +- [Service]({{ baseurl }}configuration/service/index.md): DHCP, DNS forwarding, SNMP, SSH, HTTPS API +- [VRF]({{ baseurl }}configuration/vrf/index.md): Virtual routing and forwarding + +## Operations + +- [Operational Commands]({{ baseurl }}operation/index.md): Show, monitor, restart commands + +## Installation + +- [Installation Guide]({{ baseurl }}installation/index.md): Bare metal, virtual, cloud deployments + +## Automation + +- [Automation]({{ baseurl }}automation/index.md): Ansible, Terraform, HTTP API, NETCONF + +## Configuration Examples + +- [Blueprints]({{ baseurl }}configexamples/index.md): Real-world topology examples + +## Optional + +- [Contributing]({{ baseurl }}contributing/index.md): Development workflow +- [VPP]({{ baseurl }}vpp/index.md): Vector Packet Processing integration |
