| Age | Commit message (Collapse) | Author |
|
Wrap prose lines exceeding 80 chars and apply stop/start_vyoslinter
markers around cfgcmd/opcmd directive lines that cannot be shortened
(e.g. long option names with placeholder arguments).
Affected files: bonding, wireguard, pim, conntrack-sync, dmvpn,
ipsec_general, site2site_ipsec, vrf/index, bare-metal,
inter-vrf-routing-vrf-lite, lac-lns, tunnelbroker, OpenVPN_with_LDAP,
dmvpn-dualhub-dualcloud.
🤖 Generated by [robots](https://vyos.io)
|
|
The following files were touched by the WebP image PR and exposed
pre-existing lint violations — real IPs needed for authenticity or
actual protocol addresses (OSPF router-IDs, MAC-embedded IPv6):
- inter-vrf-routing-vrf-lite.rst: 195.51.100.1, 198.51.0.0/16
- ipsec-cisco-route-based.rst: 1.1.1.1, 2.2.2.2, 1.0.0.0 (Cisco loopback/OSPF RID)
- ipsec-pa-route-based.rst: 1.1.1.1, 2.2.2.2 (PA/VyOS OSPF RIDs)
- lac-lns.rst: 8.8.8.8 (DNS example)
- pppoe-ipv6-basic.rst: ::64 (prefix format illustration)
- bridge.rst: 33:33::16:50:0 (MAC address in firewall log)
🤖 Generated by [robots](https://vyos.io)
|
|
The tunnelbroker.net example intentionally uses real Hurricane Electric
IPv6 addresses (2001:470:*) — needed for authenticity. Wrap all
affected code blocks with stop/start_vyoslinter.
🤖 Generated by [robots](https://vyos.io)
|
|
|
|
|
|
|
|
|
|
|
|
* ci: add AI documentation validation workflow
* fix: address Copilot review — fork PR safety, least-privilege, DB fallback
- Add secrets availability check; skip workflow gracefully for fork PRs
where secrets are unavailable (instead of hard-failing)
- Remove unused id-token: write permission (no OIDC in this workflow)
- Add continue-on-error on reference DB download; skip Pass 1 with
warning when artifact is missing for the target branch
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: restore id-token: write — required by claude-code-action OIDC
claude-code-action@v1 uses OIDC internally to authenticate. The
Copilot suggestion to remove it was incorrect.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: include ANTHROPIC_API_KEY in secrets check, update prompt for DB skip
- Add ANTHROPIC_API_KEY to the secrets availability gate so the
workflow skips cleanly when any required secret is missing
- Update Claude prompt to handle the case where reference DB download
failed and Pass 1 was skipped
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
(#1820)
|
|
(#1808)
Add information about a new operational command which
compares configuration between nodes participating
in config synchronization.
|
|
Avoids dropping types that Sphinx or themes may add in future versions.
Deduplicates if WebP is already present.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Replaces class-level patching of StandaloneHTMLBuilder/DirectoryHTMLBuilder
with a builder-inited event hook that only modifies html, dirhtml, and
readthedocs builders. This avoids unintentionally affecting EPUB or
HTMLHelp builders that inherit from StandaloneHTMLBuilder.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
ReadTheDocs uses a builder that subclasses DirectoryHTMLBuilder,
not StandaloneHTMLBuilder. Patch both to ensure WebP is preferred
in all HTML build variants.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
The file contained a hardcoded ReadTheDocs API token. Remove from
tracking and add to .gitignore. The token must be revoked/rotated
since it was pushed to a public repository.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Sphinx 7.2.x does not include image/webp in the HTML builder default
supported_image_types, so wildcard references resolved to PNG. Patch
the priority list so HTML builds select WebP while LaTeX stays unaffected.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Add WebP versions of all 187 PNG/JPG images (38MB → 17MB, 55% reduction).
Update RST/MD references to use Sphinx wildcard syntax (.*) so HTML builds
use WebP while PDF/LaTeX builds fall back to original PNG/JPG.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* feat: add sphinx-llms-txt and sphinx-sitemap dependencies
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: register sphinx-llms-txt and sphinx-sitemap extensions
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: add curated llms.txt for LLM discovery
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: update robots.txt with explicit AI bot allowances
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: configure sphinx-llms-txt and sphinx-sitemap options
Disable auto-generated llms.txt (curated version served from
_html_extra instead). Set sitemap_url_scheme to avoid doubled
lang/version path segments since html_baseurl already includes
/en/latest/.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
instructions (#1831)
Follow-up to #1830 (merged before these fixes landed):
- CLAUDE.md: remove misleading 'run from docs/' note, clarify heading
rule allows field lists before first heading
- copilot-instructions.md: add 'Known False Positives' section
documenting 7 verified false positive patterns from automated reviews
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* docs: reformat wireless.rst for readability and consistency
Reformat wireless interface documentation: standardize heading
hierarchy, rewrap long lines, fix code-block indentation, and
improve overall structure for readability.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix content regressions in wireless.rst reformat
Restore original wording incorrectly changed during reformat:
- Title: 'Wireless LAN / Wi-Fi' (not 'WLAN/WIFI')
- lastproofread: 2026-03-23 (not 2024-07-04)
- 'System-wide' (not 'System Wide')
- 'may be rejected' (not 'maybe rejected')
- '802.1X' (not '802.1x')
- 'electromagnetic damping' (not 'electro-magnetic dampening')
- Throughput units: '10 MB/s', '50 MB/s' (not '10MBytes/s')
- Restore channel description with automatic selection (0)
- Fix opcmd grammar
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: restore upstream prose wording in wireless.rst
Address review feedback from @dmbaturin — restore original wording
where prose was unnecessarily rewritten:
- Restore intro paragraph (remove 'by means of compatible hardware')
- Restore 'Resulting configuration:' (was changed to 'Resulting in')
- Restore concise AP/Wi-Fi 6 setup text and section headers
- Keep formatting improvements (line wrapping, heading hierarchy)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: restore more upstream wording in wireless.rst
Restore original text at three more locations:
- Use backtick-quoted access-point mode (CLI token style)
- Restore device type bullet formatting with colons and abbr
- Restore HT40 channel availability note wording
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* ci: add CLAUDE.md and GitHub Copilot custom instructions
Add AI assistant instructions to improve automated review quality:
- CLAUDE.md: project conventions, RST rules, linter details
- .github/copilot-instructions.md: repo-wide Copilot context
- .github/instructions/rst-linter.instructions.md: linter rules
for RST files (address space, line length, suppression syntax)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix build commands, code-block exemption, and address space heading
- Fix Docker build/run commands to match README (vyos/vyos-documentation
image, /vyos mount, /vyos/docs workdir)
- Fix local build to run from docs/ directory
- Clarify code-block lines are exempt from 80-char limit
- Expand address space heading to reference docs/documentation.rst
- Fix confusing 0.0.0.0/0 entry in common mistakes
- Simplify inline code backtick example
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: expand Copilot instructions to reduce false positive reviews
Add guidance for common false positives observed in automated reviews:
- Only flag issues introduced by the PR, not pre-existing
- Column-0 linter markers are the repo convention, not a bug
- Code-block lines are exempt from 80-char limit
- RFC 1918 and other private IPs are allowed without suppression
- TODO markers can be intentionally added for tracking
- YAML in code blocks uses RST-relative indentation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix backtick rendering and linter marker indentation guidance
- CLAUDE.md: use fenced code span to show RST double-backtick syntax
- copilot-instructions.md: markers match surrounding indentation inside
directives, column 0 at top level (both patterns exist in repo)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* docs: fix typos and improve prose in terraform, ansible, and config docs
Fix typos (VyoS→VyOS, respresent→represents), rewrap long prose
lines for readability, restore correct YAML indentation in Ansible
examples, and standardize heading hierarchy in affected files.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: replace public DNS IP with RFC 5737 address in NMP example
Use 198.51.100.1 (TEST-NET-2) instead of 8.8.8.8 to satisfy the
documentation linter requirement for reserved addresses.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: restore linter markers around NMP code block with 8.8.8.8
Restore stop/start_vyoslinter markers that were incorrectly removed.
The DNS server address is intentional and should not be changed.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Remove TODO tracking comments, reformat stub notes with inline
links, add stop/start_vyoslinter markers around long code blocks,
and fix minor structural issues across 23 documentation files.
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Normalize top-level page headings from = or * underline-only to #
overline+underline format, following RST/Sphinx best practices for
consistent heading hierarchy.
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* docs: fix tab-to-space indentation in code blocks across 5 files
Replace tab characters with spaces inside code-block and output
directives for consistent rendering. Also rewrap long prose lines
for readability.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* chore: remove accidentally committed settings file
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix inconsistent indentation in trafficpolicy and qos code blocks
Normalize indentation within code blocks where tab-to-space
conversion left some entries misaligned (tbit, gibps, tibps
in trafficpolicy; egress command in qos).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
|
|
|
|
* Initial proofread
* Edit ipv6.rst
* Use cfgcmd command syntax
* Fix line length lint errors
* Implement feedback
|
|
|
|
* Proofread terraformAWS.rst
* Proofread terraformAZ.rst
* Edit terraformGoogle.rst
* Edit terraformvSphere.rst
* Move directory of Terraform guides into terraform/index
* Fix line length lint errors
* Fix addtional line length lint errors
|
|
* Initial proofread
* Fix line length lint errors
|
|
|
|
|
|
|
|
|
|
* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: fill TBD placeholder in flow-accounting, remove TBD in static routes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* docs: add stub admonitions to 3 minimal pages
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: replace non-RFC IP addresses and suppress false positives in linter
Replace public IPs with RFC 5737 documentation addresses and add
stop/start_vyoslinter markers for false positives (MAC addresses,
OIDs, NAT64 well-known prefix).
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: replace remaining non-RFC IPs and suppress MAC address false positive
- Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in:
- docs/configexamples/ansible.rst (3 occurrences)
- docs/configexamples/nmp.rst (1 occurrence)
- docs/automation/terraform/terraformvSphere.rst (1 occurrence)
- Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with
stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: wrap long lines to comply with 80-char line length limit
Wrapped prose content exceeding 80 characters in 9 documentation files.
Only RST prose and directive content was modified; code block contents
were left untouched as they are exempt from the linter.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: wrap 2 remaining long lines for linter compliance
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: suppress linter for long URL reference in terraformvSphere.rst
* fix: address Copilot review suggestions — broken links, typos, YAML indentation
- Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst,
oracle.rst (stub notes with VyOS documentation repository link)
- Fix YAML indentation in both playbook code blocks in ansible.rst
- Fix typo "VyoS" -> "VyOS" in ansible.rst
- Fix typo "desition" -> "decision" in terraformvSphere.rst
- Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst
- Fix :doc: role split across two lines in openvpn-examples.rst
- Wrap long paragraph in openconnect.rst to <=80 chars and remove
unnecessary stop/start_vyoslinter markers
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: resolve remaining linter failures — long lines and OID false positive
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
* Add design spec for documentation improvements
Covers 4 work streams: mechanical fixes (headings, indentation, typos),
content quality (TODO flags, TBD fills, stub markers), structural
reorganization (troubleshooting split, contributing index, VPN cleanup),
and RTD platform cleanup (hide versions, delete stale redirects).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Fix spec issues from review: correct heading chars, tab counts, line numbers
Addresses 10 reviewer findings: corrected heading character types
(^ was actually -), removed ip.rst (already correct), updated file
count from 37 to 35, listed all 13 tab-containing files, fixed
troubleshooting line count to 460, added heading level guidance for
split pages, clarified contributing/documentation.rst scope, removed
current from hide list, added rollback verification step, updated
success criteria.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Add implementation plan for documentation improvements
16 tasks across 4 work streams: mechanical fixes (PR 1, tasks 1-6),
content quality (PR 2, tasks 7-10), structural reorg (PR 3, tasks 11-14),
and RTD platform cleanup (tasks 15-16).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Fix 6 issues from plan review
- Replace hardcoded RTD token with $RTD_TOKEN variable
- Fix Task 7 heading reference to be format-agnostic
- Correct RTD PATCH expected response (200, not 204)
- Fix version verification to check hidden field, not active
- Account for blank lines 402-403 in troubleshooting split
- Clarify start/stop_vyoslinter handling in system.rst
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* refactor: split troubleshooting into 5 focused sub-pages
Split monolithic 460-line troubleshooting/index.rst into:
- connectivity.rst (ping, traceroute, mtr, IPv6 discovery)
- interfaces.rst (interface naming, MAC addresses)
- monitoring.rst (traffic dumps, bandwidth, iperf)
- terminal.rst (console clearing, counter resets)
- system.rst (boot steps, system information)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* refactor: create contributing/index.rst, simplify root toctree
* fix: remove 'pages to sort' placeholders from VPN section
* fix: wrap long lines in index.rst for linter compliance
* Add design spec for sitemap generation improvement
* Fix sitemap spec: remove invalid sitemap_excludes, add version pin
* fix: address Copilot review suggestions — grammar, typos, RST markup fixes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: resolve remaining long lines in index.rst
Shorten :ref: display text on two lines that exceeded the 80-char
limit: "Virtual Environment" -> "VM" (line 24, 90 -> 73 chars) and
"Configuration Blueprints" -> "Blueprints" (line 51, 85 -> 71 chars).
Both targets remain correct; display text is clear in context.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* chore: remove superpowers specs from PR
Specs moved to personal branch yuriy/docs-modernization-specs.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* DOC: Proofread wireless.rst
* Apply suggestion from @dmbaturin
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Six design specs covering LLM adaptation, RST→MyST migration,
Cloudflare hosting, visual editor, mobile performance, and
visitor tracking. Includes project summary PDF for team sharing.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
They are kept in Phorge and the KB
and do not need to be duplicated here
|
|
chore: remove accidentally committed superpowers files
|
|
Reverts commits 647ce9fa, 8cc5f5e3, 00eea86c, d9738a0b which accidentally
committed internal Claude Code brainstorming artifacts (design spec and
implementation plan) to the public repo.
Also adds .superpowers/ to .gitignore to prevent future accidental commits
of session files generated by the Claude Code superpowers plugin.
|
|
- Replace hardcoded RTD token with $RTD_TOKEN variable
- Fix Task 7 heading reference to be format-agnostic
- Correct RTD PATCH expected response (200, not 204)
- Fix version verification to check hidden field, not active
- Account for blank lines 402-403 in troubleshooting split
- Clarify start/stop_vyoslinter handling in system.rst
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
16 tasks across 4 work streams: mechanical fixes (PR 1, tasks 1-6),
content quality (PR 2, tasks 7-10), structural reorg (PR 3, tasks 11-14),
and RTD platform cleanup (tasks 15-16).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Addresses 10 reviewer findings: corrected heading character types
(^ was actually -), removed ip.rst (already correct), updated file
count from 37 to 35, listed all 13 tab-containing files, fixed
troubleshooting line count to 460, added heading level guidance for
split pages, clarified contributing/documentation.rst scope, removed
current from hide list, added rollback verification step, updated
success criteria.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Covers 4 work streams: mechanical fixes (headings, indentation, typos),
content quality (TODO flags, TBD fills, stub markers), structural
reorganization (troubleshooting split, contributing index, VPN cleanup),
and RTD platform cleanup (hide versions, delete stale redirects).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
|