docs: remove TODO markers, fix stub notes, add linter markers (#1828)

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>

2 files changed, 36 insertions, 8 deletions

diff --git a/docs/automation/vyos-govyos.rst b/docs/automation/vyos-govyos.rst
index 32222441..659c2b6e 100644
--- a/docs/automation/vyos-govyos.rst
+++ b/docs/automation/vyos-govyos.rst
@@ -2,17 +2,21 @@
 
 .. _vyos-govyos:
 
+#######
 go-vyos
-=======
+#######
 
 go-vyos is a Go library designed for interacting with VyOS devices through
 their REST API. This documentation is intended to guide you in using go-vyos for
 programmatic management of your VyOS devices.
 
-- `go-vyos Documentation & Source Code on GitHub <https://github.com/ganawaj/go-vyos>`_
+- `go-vyos Documentation & Source Code on GitHub
+  <https://github.com/ganawaj/go-vyos>`_
   allows you to access and contribute to the library's code.
-- `go-vyos on pkg.go.dev <https://pkg.go.dev/github.com/ganawaj/go-vyos@v0.1.0/vyos>`_ for detailed instructions
-  on the installation, configuration, and operation of the go-vyos library.
+- `go-vyos on pkg.go.dev
+  <https://pkg.go.dev/github.com/ganawaj/go-vyos@v0.1.0/vyos>`_
+  for detailed instructions on the installation, configuration, and
+  operation of the go-vyos library.
 
 
 Installation
@@ -30,11 +34,15 @@ Getting Started
 Importing and Disabling TLS Verification
 -------------------------------------------------
 
+.. stop_vyoslinter
+
 .. code-block:: none
 
     import "github.com/ganawaj/go-vyos/vyos"
     client := vyos.NewClient(nil).WithToken("AUTH_KEY").WithURL("https://192.168.0.1").Insecure()
 
+.. start_vyoslinter
+
 Initializing a VyDevice Object
 ------------------------------
 
@@ -64,6 +72,8 @@ Using go-vyos
 Configure, then Set
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. stop_vyoslinter
+
 .. code-block:: none
 
     out, resp, err := c.Conf.Set(ctx, "interfaces ethernet eth0 address 192.168.1.1/24")
@@ -73,6 +83,8 @@ Configure, then Set
 
     fmt.Println(out.Success)
 
+.. start_vyoslinter
+
 Show a Single Object Value
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/docs/automation/vyos-salt.rst b/docs/automation/vyos-salt.rst
index 12be32a1..3a5b17d7 100644
--- a/docs/automation/vyos-salt.rst
+++ b/docs/automation/vyos-salt.rst
@@ -4,8 +4,9 @@
 
 .. include:: /_include/need_improvement.txt
 
+####
 Salt
-====
+####
 
 VyOS supports op-mode and configuration via salt_.
 
@@ -172,6 +173,8 @@ Examples
 
 Example of op-mode:
 
+.. stop_vyoslinter
+
 .. code-block:: none
 
   / # salt r11-proxy netmiko.send_command 'show interfaces ethernet eth0 brief' host=192.0.2.14 device_type=vyos username=vyos password=vyos
@@ -180,10 +183,14 @@ Example of op-mode:
       Interface        IP Address                        S/L  Description
       ---------        ----------                        ---  -----------
       eth0             192.0.2.14/24                     u/u  Upstream
-  / # 
+  / #
+
+.. start_vyoslinter
 
 Example of configuration:
 
+.. stop_vyoslinter
+
 .. code-block:: none
 
   / # salt r11-proxy netmiko.send_config config_commands=['set interfaces ethernet eth0 description Link_to_WAN'] commit=True host=192.0.2.14 device_type=vyos username=vyos password=vyos
@@ -196,7 +203,12 @@ Example of configuration:
       vyos@r14#
   / #
 
-Example of configuration commands from the file "/srv/salt/states/commands.txt"
+.. start_vyoslinter
+
+Example of configuration commands from the file
+"/srv/salt/states/commands.txt"
+
+.. stop_vyoslinter
 
 .. code-block:: none
 
@@ -212,5 +224,9 @@ Example of configuration commands from the file "/srv/salt/states/commands.txt"
       vyos@r1#
   / #
 
+.. start_vyoslinter
+
 .. _salt: https://docs.saltproject.io/en/latest/contents.html
-.. _netmiko: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.netmiko_mod.html#module-salt.modules.netmiko_mod
\ No newline at end of file
+.. stop_vyoslinter
+.. _netmiko: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.netmiko_mod.html#module-salt.modules.netmiko_mod
+.. start_vyoslinter
\ No newline at end of file