<feed xmlns='http://www.w3.org/2005/Atom'>
<title>vyos-documentation.git/.github/instructions/doc-linter.instructions.md, branch current</title>
<subtitle>VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git)
</subtitle>
<id>https://git.amelek.net/vyos/vyos-documentation.git/atom?h=current</id>
<link rel='self' href='https://git.amelek.net/vyos/vyos-documentation.git/atom?h=current'/>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/'/>
<updated>2026-05-10T16:16:39+00:00</updated>
<entry>
<title>docs: suppress literal public IP examples in linter guide</title>
<updated>2026-05-10T16:16:39+00:00</updated>
<author>
<name>copilot-swe-agent[bot]</name>
<email>198982749+Copilot@users.noreply.github.com</email>
</author>
<published>2026-05-10T16:16:39+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=38d085ece37d571a3ab280ce2fcf9b075c00c535'/>
<id>urn:sha1:38d085ece37d571a3ab280ce2fcf9b075c00c535</id>
<content type='text'>
Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/5d679560-8a77-4735-b585-74c09293eea5

Co-authored-by: andamasov &lt;12631358+andamasov@users.noreply.github.com&gt;
</content>
</entry>
<entry>
<title>fix: scope vyoslinter markers to real parser contexts</title>
<updated>2026-05-10T16:15:47+00:00</updated>
<author>
<name>copilot-swe-agent[bot]</name>
<email>198982749+Copilot@users.noreply.github.com</email>
</author>
<published>2026-05-10T16:15:47+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=d2814d1ea147f89081e15d656bc7172018ee537b'/>
<id>urn:sha1:d2814d1ea147f89081e15d656bc7172018ee537b</id>
<content type='text'>
Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/5d679560-8a77-4735-b585-74c09293eea5

Co-authored-by: andamasov &lt;12631358+andamasov@users.noreply.github.com&gt;
</content>
</entry>
<entry>
<title>ci: extend doc-linter to MyST Markdown</title>
<updated>2026-05-10T16:11:24+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-10T16:11:24+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=7a3aa29fc010c2604b84d6437ed87053947f3f27'/>
<id>urn:sha1:7a3aa29fc010c2604b84d6437ed87053947f3f27</id>
<content type='text'>
Active docs are now MyST `.md`; the linter previously only inspected
`.rst` and `.txt`, so ~250 active pages were unchecked for IP usage and
line length on every PR.

scripts/doc-linter.py:
- Add `.md` to the extension filter (use `endswith` for correctness;
  the prior 4-char slice silently skipped `.md` files).
- Track MyST/Markdown fenced code blocks (```` ``` ```` and `:::`) for
  line-length exemption — same semantics as `.. code-block::` for RST.
- Recognize both suppression marker forms: `.. stop_vyoslinter` /
  `.. start_vyoslinter` (RST and `.txt` includes) and `% stop_vyoslinter`
  / `% start_vyoslinter` (MyST). Both work in either context; pick the
  form that matches the surrounding parser.
- Replace the brittle `try/finally: fp.close()` with a `with` block —
  the previous form raised `UnboundLocalError` if `open()` itself
  failed.
- Fix typo `forgett` → `forget`.

.github/instructions/rst-linter.instructions.md → doc-linter.instructions.md:
- Broaden `applyTo` from `**/*.rst` to `**/*.md,**/*.rst,**/*.txt`.
- Document MyST suppression syntax and fenced-code line-length
  exemption.
- Note the parser-form rule for `{eval-rst}` blocks.

No regression on `.txt` includes: identical lint output verified
against the origin/rolling baseline on a sample of files.

Pre-existing IP violations exist in 14 `.md` files (e.g.
`configexamples/lac-lns.md` line 95 — a `8.8.8.8` already wrapped in
`% stop_vyoslinter`/`% start_vyoslinter`, correctly suppressed). PRs
touching unsuppressed violations will start failing CI; this is the
intent of enabling the check.

🤖 Generated by [robots](https://vyos.io)
</content>
</entry>
</feed>
