docs: fix heading hierarchy, clean up formatting, remove stubs

[andamasov]

Summary

• Correct RST heading hierarchy across 35+ files (standardize # for top-level, = for sections)
• Fix tab-to-space issues in 13 RST files
• Clean up wireless.rst formatting (550 lines reformatted)
• Remove redundant stub markers from pages that already have content
• Standardize page structure and fix minor formatting inconsistencies
• Clean up .gitignore (remove superpowers entries)

Combines work from fix/docs-content-quality, fix/docs-content-quality-v2, and fix/docs-mechanical-cleanup branches, rebased onto current.

Test plan

• Sphinx build passes without warnings
• All RST pages render correctly
• No broken cross-references

🤖 Generated with Claude Code

[Copilot]

Pull request overview

This PR performs a broad documentation mechanical cleanup across the VyOS docs tree, primarily standardizing reStructuredText heading hierarchy/formatting, fixing whitespace issues, and removing/adjusting various stub/todo markers, plus a small .gitignore cleanup.

Changes:

• Standardize RST heading markup and general formatting/whitespace across many docs pages.
• Reformat several large example/code-block sections (tabs → spaces, line wrapping).
• Remove .gitignore entries related to “superpowers” generated files.

Reviewed changes

Copilot reviewed 55 out of 63 changed files in this pull request and generated 23 comments.

Show a summary per file

File	Description
docs/vpp/configuration/ipfix.rst	Heading hierarchy normalization
docs/operation/information.rst	Heading hierarchy normalization
docs/installation/virtual/proxmox.rst	Heading hierarchy normalization
docs/installation/virtual/libvirt.rst	Heading hierarchy normalization
docs/installation/virtual/eve-ng.rst	Stub note formatting/link cleanup
docs/installation/virtual/docker.rst	Heading hierarchy normalization
docs/installation/update.rst	Heading hierarchy normalization
docs/installation/install.rst	Whitespace cleanup in example output
docs/installation/cloud/oracle.rst	Stub note formatting/link cleanup
docs/configuration/vpn/rsa-keys.rst	List formatting/line wrapping
docs/configuration/vpn/openconnect.rst	Paragraph reflow in auth section
docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst	Line wrapping for readability
docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst	Heading hierarchy + TODO note
docs/configuration/vpn/ipsec/index.rst	Toctree adjustments + placeholder section
docs/configuration/vpn/index.rst	Toctree adjustments + placeholder section
docs/configuration/trafficpolicy/index.rst	Tabs → spaces in code blocks
docs/configuration/system/sysctl.rst	Stub note formatting + typo fix
docs/configuration/system/lcd.rst	Heading hierarchy normalization
docs/configuration/system/flow-accounting.rst	Content replaced in cfgcmd description
docs/configuration/service/snmp.rst	Remove TODO marker
docs/configuration/service/mdns.rst	Heading hierarchy normalization
docs/configuration/service/eventhandler.rst	Tabs → spaces in code blocks (examples)
docs/configuration/protocols/static.rst	Reflow cfgcmd directives/descriptions
docs/configuration/policy/index.rst	Metadata formatting
docs/configuration/policy/examples.rst	Remove TODO marker
docs/configuration/nat/nat66.rst	Line wrapping for readability
docs/configuration/nat/nat64.rst	Remove TODO + linter markers cleanup
docs/configuration/loadbalancing/wan.rst	Heading hierarchy + TODO note
docs/configuration/interfaces/wireless.rst	Large formatting rewrite of wireless docs
docs/configuration/interfaces/vti.rst	Remove TODO marker
docs/configuration/interfaces/tunnel.rst	Heading hierarchy normalization
docs/configuration/interfaces/openvpn-examples.rst	Heading hierarchy + minor formatting
docs/configuration/index.rst	Fix sentence wording (still needs grammar)
docs/configuration/highavailability/index.rst	Heading hierarchy normalization
docs/configuration/firewall/index.rst	Remove TODO marker
docs/configexamples/zone-policy.rst	Heading hierarchy normalization
docs/configexamples/wan-load-balancing.rst	Heading hierarchy normalization
docs/configexamples/site-2-site-cisco.rst	Heading hierarchy normalization
docs/configexamples/qos.rst	Tabs → spaces in code blocks
docs/configexamples/policy-based-ipsec-and-firewall.rst	Heading hierarchy normalization
docs/configexamples/nmp.rst	Reflow text + example value edits
docs/configexamples/l3vpn-hub-and-spoke.rst	Tabs → spaces alignment in command outputs
docs/configexamples/index.rst	Heading hierarchy normalization
docs/configexamples/fwall-and-vrf.rst	Heading hierarchy normalization
docs/configexamples/fwall-and-bridge.rst	Heading hierarchy normalization
docs/configexamples/firewall.rst	Heading hierarchy normalization
docs/configexamples/azure-vpn-dual-bgp.rst	Heading hierarchy normalization
docs/configexamples/azure-vpn-bgp.rst	Heading hierarchy normalization
docs/configexamples/ansible.rst	Reflow + example playbook formatting (now invalid YAML)
docs/cli.rst	Tabs → spaces alignment in CLI output
docs/automation/vyos-salt.rst	Heading hierarchy normalization
docs/automation/vyos-pyvyos.rst	Heading hierarchy normalization
docs/automation/vyos-netmiko.rst	Heading hierarchy normalization
docs/automation/vyos-napalm.rst	Heading hierarchy normalization
docs/automation/vyos-govyos.rst	Heading hierarchy normalization
docs/automation/vyos-ansible.rst	Heading hierarchy normalization
docs/automation/terraform/terraformvyos.rst	Heading hierarchy normalization
docs/automation/terraform/terraformvSphere.rst	Heading hierarchy + heavy reflow (typos introduced)
docs/automation/terraform/terraformGoogle.rst	Heading hierarchy + whitespace alignment
docs/automation/terraform/terraformAZ.rst	Heading hierarchy + whitespace alignment
docs/automation/terraform/terraformAWS.rst	Heading hierarchy + whitespace alignment
docs/automation/command-scripting.rst	Heading hierarchy normalization
.gitignore	Remove “superpowers” ignore entries

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 57 out of 61 changed files in this pull request and generated 14 comments.

Comments suppressed due to low confidence (1)

docs/automation/terraform/terraformvyos.rst:37

• There are multiple Terraform typos here (“terraforms”, “Terrafom”) which will show up in published docs. Please correct to “Terraform”.

In this article, we will look at using terraforms to deploy VyOS on
platforms - AWS, Azure, and vSphere.
For more details about Terraform please have a look here link_.

Need to install_ Terraform

Structure of files in the standard Terraform project:

.. code-block:: none

 .
 ├── main.tf             # The main script
 ├── version.tf          # File for the changing version of Terraform.
 ├── variables.tf        # The file of all variables in "main.tf"
 └── terraform.tfvars    # The value of all variables (passwords,
                      # login, ip adresses and so on)


General commands that we will use for running Terraform scripts


.. code-block:: none

  cd /<your folder>       # go to the Terrafom project
  terraform init          # install all addons and provider (aws az and so on)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 57 out of 61 changed files in this pull request and generated 6 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.