VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git) https://git.amelek.net/vyos/vyos-documentation.git/atom?h=rolling 2026-05-13T10:02:51+00:00 2026-05-13T10:02:51+00:00 Claude noreply@anthropic.com 2026-05-13T10:02:51+00:00 urn:sha1:10d1e3ee6a47a1cda64680ce4cbd6def0c8d5d25 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. 2026-05-13T09:22:40+00:00 Claude noreply@anthropic.com 2026-05-13T09:22:40+00:00 urn:sha1:dd031e648850ed4409512548fa09bd0ca8d8060e The MyST migration is complete: source_suffix in docs/conf.py is now ['.md'] only, all canonical pages are .md, and the pre-migration RST originals are archived under docs/_rst_legacy/ (excluded from the build). Update the README accordingly: - Add a 'Source format' section stating pages are MyST Markdown and pointing at the _rst_legacy/ archive so newcomers know not to edit it. Mention that the VyOS command directives are written as MyST fenced blocks via myst_fence_as_directive, and that docs/_include/ *.txt snippets stay RST because cmdincludemd parses their content as RST (per 9c815d6). - Drop the stale 'MyST Markdown for migrated pages, RST for the rest' line from the Contributing section; rephrase to point at the actual topics AGENTS.md covers today (MyST conventions, command directives, linter suppression markers, Copilot/CodeRabbit workflow). 2026-05-10T15:06:54+00:00 Yuriy Andamasov yuriy@vyos.io 2026-05-10T15:06:54+00:00 urn:sha1:3a544f6f73dadb0e50f32a4c73e7efa3772b4f49 - Rewrite README.md: drop Python 2 install dance, drop `sphinx-panels` (removed years ago), drop `sudo pip install` antipattern, replace with venv + requirements.txt path. Refresh the branch table to current naming, point contributors at AGENTS.md for the full guide. Refresh the docs status badge to reference `rolling` (was `latest`). - AGENTS.md: replace remaining `current` branch references with `rolling` in the branch table, the "PRs target …" line, and the RTD layout table Branch column. The default branch was renamed `current` → `rolling` on 2026-05-10 (commit 8dbf8b05 only swept CI). 🤖 Generated by [robots](https://vyos.io) 2026-05-10T12:33:32+00:00 Yuriy Andamasov yuriy@vyos.io 2026-05-10T12:33:09+00:00 urn:sha1:8dbf8b052075b0fb7af38b7b505260e4f673a998 Cleanup PR following the current→rolling default-branch rename. Drops the now-stale current branch from workflow triggers, flips remaining defaults, and updates documentation/templates. Workflows: - pr-mirror-repo-sync.yml: branches narrowed to [rolling]; workflow_dispatch default and choice list now rolling-only; sync_branch fallback flipped from 'current' to 'rolling'. - check-open-prs-conflict.yml: dropped current from push.branches. - update-version-tags.yml: dropped current from push.branches and from the case statement (now bare 'rolling) TAG=rolling'). - submodules.yml: renamed update_current job, branch update-dependencies-current, and the related commit/title strings to rolling. - update-translations.yml: PR branch update-translations-current renamed to update-translations-rolling. - ai-validation.yml: prompt example updated. Docs/templates: - docs/conf.py: READTHEDOCS_GIT_IDENTIFIER fallback flipped to 'rolling'; comment block updated to describe the rolling branch (the user-facing "(current)" suffix is release-channel terminology and remains). - README.md: branching-scheme section now describes rolling as the default branch, with a note about the rename date. - .github/PULL_REQUEST_TEMPLATE.md: CONTRIBUTING link points at blob/rolling. External @current refs to vyos/.github and vyos/vyos-cla-signatures are left untouched — they reference those repos' default branches and are unaffected by this repo's rename. 🤖 Generated by [robots](https://vyos.io) 2026-05-07T10:13:14+00:00 Yuriy Andamasov yuriy@vyos.io 2026-05-07T10:13:14+00:00 urn:sha1:2fcc13e8f3004d0a55382601b3ce141ea976f5af The Test-the-docs section documented running vale through Docker, but vale is not in the Docker image, no .vale.ini exists, and no styles directory is present. CI uses vyoslinter (doc-linter.py) for linting. 🤖 Generated by [robots](https://vyos.io) 2025-10-21T11:28:18+00:00 Daniil Baturin daniil@baturin.org 2025-10-21T11:26:33+00:00 urn:sha1:abe1b22d41440297d719e543d77f4186def32930 2024-04-18T06:47:03+00:00 Matthew Kobayashi matthew@kobayashi.au 2024-04-18T06:47:03+00:00 urn:sha1:498a960a0553c7d496fc02cea10ff336f5143d72 2024-04-16T19:28:39+00:00 rebortg github@ghlr.de 2024-04-16T19:28:39+00:00 urn:sha1:a5fcebd11b19577e082c344fd2532e8689719d9e 2023-09-10T12:37:00+00:00 Yuxiang Zhu vfreex@gmail.com 2023-09-10T12:37:00+00:00 urn:sha1:4e3492804e32bc317a6f1fa1a38f75557e5853fe 2023-08-04T16:57:19+00:00 Daniil Baturin daniil@vyos.io 2023-08-04T16:57:19+00:00 urn:sha1:2d78e7c72dcb006e9a8a9ccc4f263e84c7a12df8