<feed xmlns='http://www.w3.org/2005/Atom'>
<title>vyos-documentation.git/docs/contributing/rst-debugging.rst, branch 1.5</title>
<subtitle>VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git)
</subtitle>
<id>https://git.amelek.net/vyos/vyos-documentation.git/atom?h=1.5</id>
<link rel='self' href='https://git.amelek.net/vyos/vyos-documentation.git/atom?h=1.5'/>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/'/>
<updated>2026-05-10T14:23:58+00:00</updated>
<entry>
<title>chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/</title>
<updated>2026-05-10T14:23:58+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-10T14:23:58+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=b6ff49dc4873e370083205d2f12bb2eb3894c7bc'/>
<id>urn:sha1:b6ff49dc4873e370083205d2f12bb2eb3894c7bc</id>
<content type='text'>
The swap mechanism (RST-as-fallback for migrated MD pages) is dormant —
docs/_rst_overrides.txt has been empty since the MyST flip trio
(#1899/#1900/#1901) 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 PR on rolling: yuriy/remove-rst-swap-mechanism

Changes:
- Move 253 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 jobs: pre_build/post_build block from .readthedocs.yml.
- 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.

Verified: sphinx-build -b html with --keep-going produces identical
warning set (68 unique), identical sitemap entry count (267), identical
llms.txt entry count (22), zero rst-* URLs in any artifact.

🤖 Generated by [robots](https://vyos.io)
</content>
</entry>
<entry>
<title>feat: flip swap mechanism on circinus — MD as primary, RST as override</title>
<updated>2026-05-06T18:08:17+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-06T18:08:17+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=3edf063d4d27d6132c67024b9560c0075fe7a48e'/>
<id>urn:sha1:3edf063d4d27d6132c67024b9560c0075fe7a48e</id>
<content type='text'>
Mirror of #1899 for circinus. Same logic, same scripts, per-branch file set.

Changes:
- Rename docs/**/md-&lt;stem&gt;.md to docs/**/&lt;stem&gt;.md (drop md- prefix) for
  all 253 stems previously listed in docs/_swap.txt
- Rename docs/**/&lt;stem&gt;.rst to docs/**/rst-&lt;stem&gt;.rst (add rst- prefix)
  for the same 253 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 rewritten with inverted rename direction
  (rst-&lt;stem&gt;.rst → &lt;stem&gt;.rst when applying overrides; &lt;stem&gt;.md
  excluded via _md_exclude.txt)
- scripts/import_myst.py and tests/test_import_myst.py deleted (obsolete)
- tests/test_swap_sources.py rewritten for new semantics

Identical change set to #1899 (current). Per-branch differences:
- circinus has 253 stems vs current's 254 (suricata is current-only)
- otherwise the script/conf.py/test changes are byte-identical with current

Generated by robots https://vyos.io
</content>
</entry>
</feed>
