diff options
| author | Claude <noreply@anthropic.com> | 2026-05-13 10:02:51 +0000 |
|---|---|---|
| committer | Claude <noreply@anthropic.com> | 2026-05-13 10:02:51 +0000 |
| commit | 10d1e3ee6a47a1cda64680ce4cbd6def0c8d5d25 (patch) | |
| tree | 4513b6f3e7ea7d9a58165cb3192788c8c4fdea76 /scripts/doc-linter.py | |
| parent | dd031e648850ed4409512548fa09bd0ca8d8060e (diff) | |
| download | vyos-documentation-10d1e3ee6a47a1cda64680ce4cbd6def0c8d5d25.tar.gz vyos-documentation-10d1e3ee6a47a1cda64680ce4cbd6def0c8d5d25.zip | |
docs(readme): wrap pre-existing long lines for MyST doc-lint
The doc-linter was extended to MyST .md files in 7a3aa29 (after the
previous README refresh in 3a544f6), so this PR is the first README
edit linted under MyST rules. The three pre-existing >80-char lines
(badge, Wayback link, rolling table row) now fail doc-lint. Wrap them:
- Switch the badge and Wayback links to reference-style. The badge
destination/image URLs become [badge]/[rtd]/[wayback] references at
the top of the file; renders identically on GitHub and in Sphinx.
- Trim the Wayback snapshot path from web/20200225171529/ to web/2020/
(year-level capture, same era as the original snapshot) to fit the
reference definition in 80 chars without a suppression marker. Using
% stop_vyoslinter here would render literally on GitHub, since the
README is GFM-rendered, not MyST.
- Shorten the rolling-branch table row from 'all new contributions
target this' to 'new contributions land here' (84 -> 78 chars).
Also address two Copilot review findings on this PR:
- Line 15 grammar: 'Pages are ... and build with Sphinx' ->
'Pages are ... and are built with Sphinx'.
- AGENTS.md still describes the source format as mixed MyST/RST
(AGENTS.md:7 and several follow-up sections). Updating AGENTS.md
in this PR would pull ~30 pre-existing long-line violations into
scope and require a bulk hard-wrap of the file, which is outside
the original README request. Leaving AGENTS.md for a follow-up PR
and noting it in the PR description.
Diffstat (limited to 'scripts/doc-linter.py')
0 files changed, 0 insertions, 0 deletions
