diff options
| -rw-r--r-- | README.md | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -3,15 +3,19 @@ Source for the VyOS user documentation hosted on Read the Docs at https://docs.vyos.io. -[](https://docs.vyos.io/en/rolling/?badge=rolling) +[![Documentation Status][badge]][rtd] The earlier wiki for VyOS 1.1.x and pre-1.2.0 docs is preserved on the -[Wayback Machine](https://web.archive.org/web/20200225171529/https://wiki.vyos.net/wiki/Main_Page). +[Wayback Machine][wayback]. + +[badge]: https://readthedocs.org/projects/vyos/badge/?version=rolling +[rtd]: https://docs.vyos.io/en/rolling/?badge=rolling +[wayback]: https://web.archive.org/web/2020/https://wiki.vyos.net/wiki/Main_Page ## Source format Pages are [MyST Markdown](https://myst-parser.readthedocs.io/) (`.md`) and -build with Sphinx — `source_suffix` in `docs/conf.py` lists `.md` only. +are built with Sphinx — `source_suffix` in `docs/conf.py` lists `.md` only. The pre-migration RST originals are archived under `docs/_rst_legacy/` for reference; they are excluded from the build and should not be edited. @@ -29,7 +33,7 @@ constellation: | Branch | VyOS version | Role | |--------|--------------|------| -| `rolling` | 1.5+ rolling | Default branch — all new contributions target this. | +| `rolling` | 1.5+ rolling | Default branch — new contributions land here. | | `circinus` | 1.5.x | LTS docs. | | `sagitta` | 1.4.x | Previous LTS docs. | | `equuleus` | 1.3.x | Legacy. | |