From 17e840a3b54e992233278f819d9c5ac2a938ba5f Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 08:26:56 +0300 Subject: docs(conf.py): name the rolling docs as "rolling (current)", not stale circinus MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The `current` branch's `release` literal was `'1.5.x (circinus)'` β€” stale since circinus split off as its own LTS branch. The rendered llms.txt verification on the RTD preview surfaced the bug as the canonical version label of the rolling docs: > This documentation covers 1.5.x (circinus). …on a build whose URLs are `/en/rolling/`. The new build-time render introduced by this PR makes the inconsistency a user-visible artifact exposed to LLM consumers, so fix the source-of-truth literal here. Now `release = 'rolling (current)'` and `version = 'rolling'`. Sphinx also exposes `release` in the page footer ("v: rolling (current)") and search metadata, so fixing this string is a single source-of-truth change for the rolling docs. Sagitta and circinus `release` strings are correct already (`'1.4.x (sagitta)'` and `'1.5.x (circinus)'` respectively); no cross-branch sweep needed for `release`. Addresses CodeRabbit review feedback on PR #1874 (the originally pushed-back release-mismatch finding β€” verification proved the push-back wrong). \xf0\x9f\xa4\x96 Generated by [robots](https://vyos.io) --- docs/conf.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 3ac6ca8d..f31dfbf4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,11 +26,16 @@ project = u'VyOS' copyright = u'2026, VyOS maintainers and contributors' author = u'VyOS maintainers and contributors' -# The short X.Y version -version = u'1.5' - -# The full version, including alpha/beta/rc tags -release = u'1.5.x (circinus)' +# The short X.Y version (rolling β€” next major; bumped at branch cut) +version = u'rolling' + +# The full version, including alpha/beta/rc tags. The `current` branch +# is the rolling tip and serves at /en/rolling/ on RTD; the literal +# below is exposed in the page footer ("v: rolling (current)") and is +# interpolated into _templates/llms.txt.j2 ("This documentation covers +# {{ release }}."). Pin this to a value that names what the rolling +# docs actually serve, not a stale LTS codename. +release = u'rolling (current)' # -- General configuration --------------------------------------------------- -- cgit v1.2.3