diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-04-10 22:38:42 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-04-10 20:38:42 +0100 |
| commit | ac7620f61d58bd213b70ffa120e91cf421920d36 (patch) | |
| tree | 4b2d0a58bbf898da3bdcc1781e28a16f3f6b24b2 | |
| parent | 15f7ceb4128c2ad0e3e8505281e3892975f8bf46 (diff) | |
| download | vyos-documentation-ac7620f61d58bd213b70ffa120e91cf421920d36.tar.gz vyos-documentation-ac7620f61d58bd213b70ffa120e91cf421920d36.zip | |
ci: fix CLAUDE.md wording and add known false positives to Copilot instructions (#1831)
Follow-up to #1830 (merged before these fixes landed):
- CLAUDE.md: remove misleading 'run from docs/' note, clarify heading
rule allows field lists before first heading
- copilot-instructions.md: add 'Known False Positives' section
documenting 7 verified false positive patterns from automated reviews
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| -rw-r--r-- | .github/copilot-instructions.md | 12 | ||||
| -rw-r--r-- | CLAUDE.md | 4 |
2 files changed, 14 insertions, 2 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index dd18e7e6..30fa5800 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -66,3 +66,15 @@ Ansible playbook examples in `.. code-block::` use RST indentation (typically 4 ### Page Structure Configuration pages follow this order: Theory, Configuration (cfgcmd), Examples, Known Issues, Debugging. + +### Known False Positives + +Do **not** flag the following — they have been verified as correct or intentional: + +- **Markdown tables rendering with `||`**: Diff views may show table pipes as double-pipes. Check the raw source file before flagging. +- **`stop/start_vyoslinter` at column 0 inside directives**: This is one of two accepted patterns. The other is indented markers matching the directive. Both are valid. +- **RFC 1918 addresses without linter suppression**: Private IPs (`10.x`, `172.16.x`, `192.168.x`) are allowed. Do not suggest adding `stop/start_vyoslinter` around them. +- **Long lines inside `.. code-block::`**: Code blocks are exempt from the 80-character line limit. +- **Pre-existing typos or grammar issues in unchanged lines**: Only flag issues introduced by the current PR's diff. If a typo exists on an unchanged line, it is out of scope. +- **Ansible YAML indentation in RST code blocks**: YAML inside `.. code-block::` is indented relative to the directive, not column 0. Verify from the code-block's indentation base before flagging as invalid. +- **Adding `.. TODO::` while removing others**: Tracking TODOs on pages needing `cfgcmd` conversion is intentional. Removing stale TODOs on completed pages is also intentional. Both can happen in the same PR. @@ -11,7 +11,7 @@ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \ -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) \ vyos/vyos-documentation make html -# Local (run from docs/ directory) +# Local pip install -r requirements.txt cd docs && make html ``` @@ -44,7 +44,7 @@ Paragraphs """""""""" ``` -Every RST file must start with a `#` overline+underline title. +The first heading in every RST file must use `#` overline+underline. Files may have field lists (e.g., `:lastproofread:`) or labels before the heading. ### Formatting Rules |