diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-02 18:59:58 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 16:18:03 +0300 |
| commit | 5a35f4d30e5c16bd85e811176cffa86b721112b7 (patch) | |
| tree | 8339f5c27d85b97196825e825f4139fe4827876c /docs/coverage.md | |
| parent | 38ff65941d6cd771700480fd2e6c88dad6a01c24 (diff) | |
| download | vyos-documentation-5a35f4d30e5c16bd85e811176cffa86b721112b7.tar.gz vyos-documentation-5a35f4d30e5c16bd85e811176cffa86b721112b7.zip | |
refactor(swap): rename imported .md files to md- prefix for swap mechanism
Restore the canary file naming convention that swap_sources.py expects:
the imported MyST pages now live as docs/<dir>/md-<name>.md alongside
the existing docs/<dir>/<name>.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-<name>.md source file ready to swap in.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/coverage.md')
| -rw-r--r-- | docs/coverage.md | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/coverage.md b/docs/coverage.md deleted file mode 100644 index fff0dc4e..00000000 --- a/docs/coverage.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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 |
