From 5a35f4d30e5c16bd85e811176cffa86b721112b7 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sat, 2 May 2026 18:59:58 +0300 Subject: refactor(swap): rename imported .md files to md- prefix for swap mechanism MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Restore the canary file naming convention that swap_sources.py expects: the imported MyST pages now live as docs//md-.md alongside the existing docs//.rst, so swap_sources.py --swap can rename them into place at build time. - 254 .md files renamed (every page with a matching .rst counterpart) - 2 MyST-only pages left at their final names (no .rst exists, no swap needed): docs/copyright.md, docs/automation/terraform/terraformvyos.md All 114 stems listed in docs/_swap.txt now have a corresponding md-.md source file ready to swap in. 🤖 Generated by [robots](https://vyos.io) --- docs/md-coverage.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/md-coverage.md (limited to 'docs/md-coverage.md') diff --git a/docs/md-coverage.md b/docs/md-coverage.md new file mode 100644 index 00000000..fff0dc4e --- /dev/null +++ b/docs/md-coverage.md @@ -0,0 +1,59 @@ +--- +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 address +
` +- xml: `interfaces ethernet address
` +- VyOS: `interfaces ethernet address ` + +**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 -- cgit v1.2.3