summaryrefslogtreecommitdiff
path: root/docs/changelog
AgeCommit message (Collapse)Author
2026-05-10chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/Yuriy Andamasov
The swap mechanism (RST-as-fallback for migrated MD pages) is dormant — docs/_rst_overrides.txt has been empty since the MyST flip trio landed. The mechanism's surface area is dead weight and the rst-*.rst shadows scattered across the source tree cause Context7's parser to misclassify the project as RST. Sibling PRs: - yuriy/remove-rst-swap-mechanism (rolling) - yuriy/remove-rst-swap-mechanism-circinus Changes: - Move 210 rst-*.rst shadow files into docs/_rst_legacy/ preserving subdirectory structure. They remain in the repo for reference; Sphinx excludes the folder via exclude_patterns. - Strip swap_sources.py invocation from docs/Makefile. - Strip rst-*.rst exclude entry and the _md_exclude.txt loader from docs/conf.py; replace with a single _rst_legacy exclude. - Delete scripts/swap_sources.py, tests/test_swap_sources.py, docs/_rst_overrides.txt. - Update AGENTS.md: drop the "RST override mechanism" section and the test-runner snippet for the deleted test. Note: .readthedocs.yml on sagitta has no jobs: block to remove (the swap was wired only at build-time via the Makefile chain on this branch). Verified: sphinx-build -b html with --keep-going produces identical warning set (409 unique — pre-existing cli.rst/aws.rst title-level warnings on this branch), identical sitemap entry count (215), identical llms.txt entry count (23), zero rst-* URLs in any artifact. 🤖 Generated by [robots](https://vyos.io)
2026-05-06feat: flip swap mechanism on sagitta — MD as primary, RST as overrideYuriy Andamasov
Mirror of #1899 (current) and #1900 (circinus) for sagitta. Same logic, same scripts, per-branch file set. Changes: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 210 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 210 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty - conf.py exclude_patterns flipped: rst-*.rst excluded by default - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt - scripts/swap_sources.py imported from current (post-#1899 rewrite, with inverted rename direction) - scripts/import_myst.py and tests/test_import_myst.py deleted (obsolete) - tests/test_swap_sources.py imported from current (post-#1899 rewrite) Side-effect: fixes the same 404 on /en/1.4/ View page source links that #1899 fixed for /en/rolling/ and #1900 fixed for /en/1.5/. Per-branch differences vs #1899: - sagitta has 210 stems vs current's 254 (sagitta has no vpp pages and fewer current-only features; cli + installation/cloud/aws are still RST-only on sagitta pending the title-level fix follow-up) - otherwise the script/conf.py/test changes are byte-identical with current Generated by robots https://vyos.io
2026-05-06feat: import MyST swap mechanism + content for sagitta (replaces #1886)Yuriy Andamasov
Replaces the broken #1886 with a fresh, properly-converted MyST set for the sagitta (1.4.x) docs, mirroring what landed for circinus via #1897. This PR: - Re-imports 210 md-*.md files for sagitta. Source: ran the pipelines rst-to-myst converter (chrisjsewell/rst-to-myst v0.4.0, with pandoc fallback) on sagittas RST. Post-processed via the pipelines postprocess stage (10 ordered fixes for blanks, admonitions, label hyphens, pandoc artifacts, structural blanks, linter markers). Compared to the broken #1886 content (which was left over from an earlier stage-1-only run): zero raw `<div class=>` remnants. - For 23 stems where sagittas RST is byte-identical with currents RST (mostly stable policy/protocol pages and the 404 page), reuses currents already-validated md-*.md content rather than re-converting. - Drops cli and installation/cloud/aws from sagittas swap set: their RST has SEVERE/4 "Title level inconsistent" errors that crash rst-to-myst; they need an independent RST-source fix and are kept as RST-only for now. - Adds the per-page swap mechanism: scripts/swap_sources.py, scripts/import_myst.py, the matching tests under tests/, _swap.txt with 210 stems, _ext/vyos.py MyST renderer fallback, Makefile swap-wrapped targets, .readthedocs.yml swap pre/post hooks. - Adds 187 .webp images and removes 235 superseded .jpg/.png/.jpeg static assets; flips html_logo to vyos-logo.webp. - Adds the MyST swap-related blocks to docs/conf.py only: myst_enable_extensions, myst_fence_as_directive, md-*.md exclude patterns, _swap_exclude.txt reader, _prefer_webp and _copy_md_sources setup hooks. github_version fallback set to 'sagitta' to match the branch (parallel to currents 'current' and circinuss 'circinus'). Deliberately excluded (per user direction): - llms.txt and sphinx-llms-txt / sphinx-sitemap config: these will land separately for sagitta via #1870 plus a new sagitta-specific llms.txt template PR. The conf.py here does not pull those extensions in, so the build does not depend on the new pip packages. Verification before pushing: - 210 md-*.md = 210 _swap.txt stems = 210 RST siblings on sagitta (1:1:1). - 0 files contain raw `<div class=` (the breakage that took down /en/1.5/). - conf.py copyright/version/release preserve sagittas values (2024 / 1.4 / "1.4.x (sagitta)") - not currents. - html_title from currents conf.py removed - PR #1880 is the right place for sagittas branch-localized title. Supersedes / closes on merge: - #1886 (broken converter output, would break /en/1.4/ if merged). Generated by robots https://vyos.io
2024-04-29Github: update sagitta branchupdate-dependencies-sagittarebortg
2024-04-22Github: update sagitta branchrebortg
2024-04-16Github: update sagitta branchrebortg
2024-04-15Github: update sagitta branchrebortg
2024-04-08Github: update sagitta branchrebortg
2024-04-01Github: update sagitta branchrebortg
2024-03-25Github: update sagitta branchrebortg
2024-03-18Github: update sagitta branchc-po
2024-01-15Github: update sagitta branchrebortg
2024-01-08Github: update sagitta branchrebortg
2024-01-01Github: update sagitta branchrebortg
2023-12-25Github: update sagitta branchrebortg
2023-12-18Github: update sagitta branchrebortg
2023-12-11Github: update sagitta branchrebortg
2023-12-04Github: update sagitta branchrebortg
2023-11-27Github: update sagitta branchrebortg
2023-09-12Github: update current branchrebortg
2023-09-12Merge branch 'master' of github.com:vyos/vyos-documentationrebortg
2023-09-12include releasenotes of 1.5rebortg
2023-09-11Github: update current branchrebortg
2023-09-04Github: update current branchrebortg
2023-08-28Github: update current branchrebortg
2023-08-21Github: update current branchrebortg
2023-08-14Github: update current branchrebortg
2023-07-31Github: update current branchrebortg
2023-07-24Github: update current branchrebortg
2023-07-17Github: update current branchrebortg
2023-07-10Github: update current branchrebortg
2023-06-26Github: update current branchrebortg
2023-06-19Github: update current branchrebortg
2023-06-12Github: update current branchrebortg
2023-06-05Github: update current branchrebortg
2023-05-29Github: update current branchrebortg
2023-05-22Github: update current branchrebortg
2023-05-15Github: update current branchrebortg
2023-05-08Github: update current branchrebortg
2023-05-01Github: update current branchrebortg
2023-04-17Github: update current branchrebortg
2023-04-17Github: update current branchrebortg
2023-04-10Github: update current branchrebortg
2023-04-03Github: update current branchrebortg
2023-03-27Github: update current branchrebortg
2023-03-20Github: update current branchrebortg
2023-03-13Github: update current branchrebortg
2023-03-06Github: update current branchrebortg
2023-02-27Github: update current branchrebortg
2023-02-20Github: update current branchrebortg
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-25 02:44:51 +0000