summaryrefslogtreecommitdiff
path: root/docs/index.rst
AgeCommit message (Collapse)Author
2026-05-06feat: flip swap mechanism — MD as primary, RST as override (Phase 1)Yuriy Andamasov
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
2026-03-30Split troubleshooting, add contributing index, clean VPN structure (#1804)Yuriy Andamasov
* 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>
2026-03-26T8433: remove changelogs from documentation (#1809)Daniil Baturin
They are kept in Phorge and the KB and do not need to be duplicated here
2025-10-13cla: Add CLA references and instructions (#1690)zdc
- Added a dedicated page describing the process of signing the CLA - Added references to this page on documents explaining how to submit code and documentation changes
2025-09-04VPP: Add comprehensive VPP documentationzdc
This commit introduces extensive documentation for VyOS VPP (Vector Packet Processing) Dataplane interfaces and features, including examples. Features documented: * VPP integration description, base requirements and limitations * VPP dataplane core settings * Features enabled in the dataplane: ACL, IPsec, NAT, sFlow * VPP interface types: bonding, bridge, GRE, IPIP, kernel, loopback, VXLAN, XConnect Note: This is an initial documentation version that will require ongoing improvements based on user feedback and questions, real-world deployment testing and validation, additional use cases and configuration scenarios discovered in production. Therefore, all pages are marked as "need improvement".
2024-10-08Rename chapters and remove redundant VyOS wordingChristian Breunig
2024-01-13update sphinx and dependenciesrebortg
2023-02-12T5001: Replace links to the phabricator siteChristian Breunig
Replace links to the phabricator site from https://phabricator.vyos.net to https://vyos.dev
2023-01-06Update index.rstChristopher Gearns
correct typo
2022-04-01add sphinx panels and create 6 panels on index.rstrebortg
2021-09-13contributing: clear structurerebortg
2021-08-16Add new testing sectionChristian Poessinger
(cherry picked from commit 7e782af3c29e28456a00785d773557da235c976a)
2020-12-10rearrange development partrebortg
2020-12-08index: decrease TOC levelrebortg
2020-12-08index: make TOC visiblerebortg
2020-12-07delete release pagerebortg
2020-12-06arrange examplesrebortg
2020-11-30arrange: system configrationrebortg
2020-11-29arrange firewallrebortg
2020-11-29rearange changelog, cli, contributingrebortg
2020-09-10appendix: reindex to nest virtual environmentscurrite
2020-08-15lcd: T2564: adjust to latest CLIChristian Poessinger
2020-08-06Split Development and Debugging chapter into individual filesChristian Poessinger
2020-08-06Create new "System Operation" main chapterChristian Poessinger
2020-08-03build-vyos: ease build instructionsChristian Poessinger
2020-06-16Add section Virtual Environmentssever-sever
2020-06-12Add section CLOUDSsever-sever
2020-03-26appendix: run VyOS inside GNS3currite
2020-03-04vrf: add initial documentationChristian Poessinger
2020-03-03appendix: http-api (#215)currite
Operational requests and configuration management requests.
2020-02-25system: rename index to advanced-indexChristian Poessinger
2020-01-23toc: move command-scripting to appendixChristian Poessinger
2020-01-22commandtree: remove as it's replaced by dynamic cmd-listChristian Poessinger
2020-01-21conf: copyright 2020Christian Poessinger
2020-01-21nptv6: move into dedicated chapterChristian Poessinger
2020-01-04Merge branch 'newdirectives'Robert Göhler
2020-01-02rename releasenotes -> release-notesChristian Poessinger
2019-12-22CMDList: add opcmdlist and cfgcmdlistRobert Göhler
2019-12-21interfaces: rename index to advanced-indexChristian Poessinger
2019-12-21interface: split into basic and advanced sectionChristian Poessinger
2019-12-20task-scheduler: rewrite with new cfgcmd syntaxChristian Poessinger
2019-12-20system: split TOC into basic system and system configurationChristian Poessinger
2019-12-20clustering: remove broken/unmaintained featuresChristian Poessinger
Could be readded in the future with e.g. pacemaker/corosync.
2019-12-12copyright: move to index pageChristian Poessinger
2019-11-29index: regroup advanced sectionChristian Poessinger
2019-11-24TOC: fix toc structureRobert Göhler
2019-11-23Revert "prevent douple heading"Christian Poessinger
This reverts commit c1ab520c4264227b5fc053aa917fdbc7d7e667af.
2019-11-23prevent douple headingRobert Göhler
2019-11-23toc: improve structure #2Christian Poessinger
2019-11-23toc: on the way to a better structured tocChristian Poessinger
generated by cgit v1.2.3 (git 2.39.1) at 2026-07-14 22:18:27 +0000