vyos-documentation.git/.github/instructions, branch docs/t8887-phase1-batch1

docs: suppress literal public IP examples in linter guide

2026-05-10T16:16:39+00:00

Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/5d679560-8a77-4735-b585-74c09293eea5 Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

fix: scope vyoslinter markers to real parser contexts

2026-05-10T16:15:47+00:00

Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/5d679560-8a77-4735-b585-74c09293eea5 Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

ci: extend doc-linter to MyST Markdown

2026-05-10T16:11:24+00:00

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)

ci: add CLAUDE.md and Copilot custom instructions (#1830)

2026-04-10T18:50:31+00:00

* ci: add CLAUDE.md and GitHub Copilot custom instructions Add AI assistant instructions to improve automated review quality: - CLAUDE.md: project conventions, RST rules, linter details - .github/copilot-instructions.md: repo-wide Copilot context - .github/instructions/rst-linter.instructions.md: linter rules for RST files (address space, line length, suppression syntax) Co-Authored-By: Claude Opus 4.6 (1M context) * docs: fix build commands, code-block exemption, and address space heading - Fix Docker build/run commands to match README (vyos/vyos-documentation image, /vyos mount, /vyos/docs workdir) - Fix local build to run from docs/ directory - Clarify code-block lines are exempt from 80-char limit - Expand address space heading to reference docs/documentation.rst - Fix confusing 0.0.0.0/0 entry in common mistakes - Simplify inline code backtick example Co-Authored-By: Claude Opus 4.6 (1M context) * docs: expand Copilot instructions to reduce false positive reviews Add guidance for common false positives observed in automated reviews: - Only flag issues introduced by the PR, not pre-existing - Column-0 linter markers are the repo convention, not a bug - Code-block lines are exempt from 80-char limit - RFC 1918 and other private IPs are allowed without suppression - TODO markers can be intentionally added for tracking - YAML in code blocks uses RST-relative indentation Co-Authored-By: Claude Opus 4.6 (1M context) * docs: fix backtick rendering and linter marker indentation guidance - CLAUDE.md: use fenced code span to show RST double-backtick syntax - copilot-instructions.md: markers match surrounding indentation inside directives, column 0 at top level (both patterns exist in repo) Co-Authored-By: Claude Opus 4.6 (1M context) --------- Co-authored-by: Claude Opus 4.6 (1M context)