Split troubleshooting, add contributing index, clean VPN structure (#1804)

* 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>

1 files changed, 39 insertions, 0 deletions

diff --git a/docs/troubleshooting/interfaces.rst b/docs/troubleshooting/interfaces.rst
new file mode 100644
index 00000000..95aceb12
--- /dev/null
+++ b/docs/troubleshooting/interfaces.rst
@@ -0,0 +1,39 @@
+###############
+Interface Names
+###############
+
+If you find the names of your interfaces have changed, this could be because
+your MAC addresses have changed.
+
+* For example, you have a VyOS VM with 4 Ethernet interfaces named
+  eth0, eth1, eth2 and eth3. Then, you migrate your VyOS VM to a different
+  host and find your interfaces now are eth4, eth5, eth6 and eth7.
+
+  One way to fix this issue **taking control of the MAC addresses** is:
+
+  Log into VyOS and run this command to display your interface settings.
+
+  .. code-block:: none
+
+     show interfaces detail
+
+  Take note of MAC addresses.
+
+  Now, in order to update a MAC address in the configuration, run this command
+  specifying the interface name and MAC address you want.
+
+  .. code-block:: none
+
+     set interfaces ethernet eth0 hw-id 00:0c:29:da:a4:fe
+
+  If it is a VM, go into the settings of the host and set the MAC address to
+  the settings found in the config.boot file. You can also set the MAC to
+  static if the host allows so.
+
+
+* Another example could be when cloning VyOS VMs in GNS3 and you get into the
+  same issue: interface names have changed.
+
+  And **a more generic way to fix it** is just deleting every MAC address at
+  the configuration file of the cloned machine. They will be correctly
+  regenerated automatically.