diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 20:42:32 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 20:42:32 +0300 |
| commit | 5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch) | |
| tree | 99359ff282846e26b5c5fa2b9b176b35b172809f /docs/rst-coverage.rst | |
| parent | 631e454d674ad5111d2b56a6964ead461894a1f6 (diff) | |
| download | vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip | |
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism
so MD becomes the canonical primary and RST becomes the rare override.
Phase 1 — file renames + conf.py exclude_patterns flip only:
- Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix)
for all 254 stems previously listed in docs/_swap.txt
- Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix)
for the same 254 stems
- Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty
comment-only since no pages need the RST fallback right now
- conf.py exclude_patterns flipped: rst-*.rst is now excluded by default
instead of md-*.md
- conf.py runtime-artifact references updated to _rst_override_state.json
and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce
these names; for now no swap script runs because overrides list is empty)
Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py
with inverted rename direction, delete scripts/import_myst.py + tests, and
update tests/test_swap_sources.py for the new semantics.
Phase 3 will be the cleanup pass and ready-for-review flip.
Generated by robots https://vyos.io
Diffstat (limited to 'docs/rst-coverage.rst')
| -rw-r--r-- | docs/rst-coverage.rst | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/rst-coverage.rst b/docs/rst-coverage.rst new file mode 100644 index 00000000..5f74e70d --- /dev/null +++ b/docs/rst-coverage.rst @@ -0,0 +1,61 @@ +:lastproofread: 2025-11-14 + +######## +Coverage +######## + +Overview over all commands that are documented in the +``.. cfgcmd::`` or ``.. opcmd::`` directives. + +The build process takes all XML definition files +from the `vyos-1x <https://github.com/vyos/vyos-1x>`_ repository and a +periodical export of all VyOS commands and extracts each leaf command, or +executable command. +The script compares only the fixed part of a command. +All variables and values are removed and the string of the commands +are compared. + +For example, take the following two commands: + + * documentation: ``interfaces ethernet <interface> address + <address | dhcp | dhcpv6>`` + * xml: ``interfaces ethernet <ethernet> address <address>`` + * VyOS: ``interfaces ethernet <text> address <value>`` + +**There are 3 kinds of issues with commands in the following tables:** + +``Not documented yet`` + + * An XML command is not found in ``.. cfgcmd::`` or ``.. opcmd::`` directives. + * The command should be documented. + +``Nothing found in XML Definitions`` + + * ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in the XML + definition. + * The command location may have changed in the XML definition, the feature + is no longer supported in VyOS, or there is a typo in the command. + +``Nothing found in VyOS`` + + * ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in VyOS + documentation or the XML definition. + * The command location may have changed in the XML definition, the feature + is no longer supported in VyOS, or there is a typo in the command. + + +The final list of commands are shown in +the following two tables: + +Configuration Commands +====================== + +.. cfgcmdlist:: + :show-coverage: + + +Operational Commands +==================== + +.. opcmdlist:: + :show-coverage:
\ No newline at end of file |
