From ca3b1adbd5363743ba1cc6f8e798102f8bb71222 Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Fri, 12 Jun 2026 16:25:59 +0100 Subject: [PATCH 1/6] Add banner to development docs to indicate version --- theme/header.hbs | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 theme/header.hbs diff --git a/theme/header.hbs b/theme/header.hbs new file mode 100644 index 000000000..1c33d448a --- /dev/null +++ b/theme/header.hbs @@ -0,0 +1,33 @@ + + +
+ This is the  development version  of the MUSE2 documentation. +
From fe616129ec0f023e96f9b92f5cbc4b5cd7adfd8b Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Tue, 16 Jun 2026 17:30:03 +0100 Subject: [PATCH 2/6] Include banner in old docs, use JS logic to determine colour --- docs/build_old_docs.py | 3 +++ theme/header.hbs | 23 +++++++++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/docs/build_old_docs.py b/docs/build_old_docs.py index e5218d07f..48278f68a 100755 --- a/docs/build_old_docs.py +++ b/docs/build_old_docs.py @@ -72,6 +72,9 @@ def build_docs_for_release(release: str, repo_path: Path, outdir: Path) -> None: # Apply patches, if any apply_patches_for_release(release, release_path) + # Copy current theme into the release worktree so theme is consistent + shutil.copytree(REPO_ROOT / "theme", release_path / "theme", dirs_exist_ok=True) + # Build docs sp.run(("just", f"{release_path!s}/build-docs"), check=True) diff --git a/theme/header.hbs b/theme/header.hbs index 1c33d448a..6ad019e46 100644 --- a/theme/header.hbs +++ b/theme/header.hbs @@ -31,3 +31,26 @@
This is the  development version  of the MUSE2 documentation.
+ + From 29383dbefa0d949fa2f2a8ac58f832f86805117c Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Tue, 16 Jun 2026 17:44:42 +0100 Subject: [PATCH 3/6] Include a stable version of the docs --- docs/build_old_docs.py | 12 +++++++++--- docs/templates/versions.md.jinja | 1 + 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/build_old_docs.py b/docs/build_old_docs.py index 48278f68a..67911777e 100755 --- a/docs/build_old_docs.py +++ b/docs/build_old_docs.py @@ -64,7 +64,7 @@ def apply_patches_for_release(release: str, repo_path: Path) -> None: sp.run(("git", "-C", str(repo_path), "am", str(patch_path)), check=True) -def build_docs_for_release(release: str, repo_path: Path, outdir: Path) -> None: +def build_docs_for_release(release: str, repo_path: Path, outdir: Path) -> Path: """Build documentation for a given release.""" print(f"Building docs for {release}") release_path = add_worktree_for_release(repo_path, release) @@ -89,6 +89,8 @@ def build_docs_for_release(release: str, repo_path: Path, outdir: Path) -> None: print(f"Copying to {release_outdir}") shutil.move((release_path / "book"), release_outdir) + return release_outdir + def build_old_docs() -> None: """Build documentation for previous releases.""" @@ -101,8 +103,12 @@ def build_old_docs() -> None: clone_repo_to(repo_path) # Generate documentation for each previous release - for release in get_releases(): - build_docs_for_release(release, repo_path, outdir) + for i, release in enumerate(get_releases()): + release_outdir = build_docs_for_release(release, repo_path, outdir) + + # Copy latest release into stable dir + if i == 0: + shutil.copytree(release_outdir, outdir / "stable") if __name__ == "__main__": diff --git a/docs/templates/versions.md.jinja b/docs/templates/versions.md.jinja index 6e5a84c64..838a91c0c 100644 --- a/docs/templates/versions.md.jinja +++ b/docs/templates/versions.md.jinja @@ -3,6 +3,7 @@ The MUSE2 documentation for different releases is available below. - [Current development version](index.html) +- [Stable version](release/stable/index.html) {%- for release in releases %} - [{{ release }}](release/{{ release }}/index.html) {%- endfor %} From 64b81ddb3f54147bc77f147afaa62a79f527baf8 Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Tue, 16 Jun 2026 17:55:20 +0100 Subject: [PATCH 4/6] Do not show a banner for the stable version --- theme/header.hbs | 60 ++++++++++++++++++++++++------------------------ 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/theme/header.hbs b/theme/header.hbs index 6ad019e46..eadd25137 100644 --- a/theme/header.hbs +++ b/theme/header.hbs @@ -2,55 +2,55 @@ :root { --banner-height: 36px; } #version-banner { + display: none; position: fixed; top: 0; left: 0; right: 0; height: var(--banner-height); z-index: 9999; - display: flex; align-items: center; justify-content: center; font-size: 0.875em; box-sizing: border-box; padding: 0 16px; - background-color: #fff3cd; - border-bottom: 1px solid #ffc107; - } - - #version-banner, #version-banner * { - color: #664d03 !important; - } - - body { padding-top: var(--banner-height); } - #mdbook-menu-bar.sticky { top: var(--banner-height) !important; } - #mdbook-sidebar { - top: var(--banner-height) !important; - height: calc(100vh - var(--banner-height)) !important; } -
- This is the  development version  of the MUSE2 documentation. -
+
From 9189824cff8c2c748d8dcd47f59c09ed9e7f01df Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Thu, 18 Jun 2026 15:32:52 +0100 Subject: [PATCH 5/6] Remove stable directory before creating it new Assisted-by: Copilot Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- docs/build_old_docs.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/build_old_docs.py b/docs/build_old_docs.py index 67911777e..e988f150d 100755 --- a/docs/build_old_docs.py +++ b/docs/build_old_docs.py @@ -108,7 +108,9 @@ def build_old_docs() -> None: # Copy latest release into stable dir if i == 0: - shutil.copytree(release_outdir, outdir / "stable") + stable_dir = outdir / "stable" + shutil.rmtree(stable_dir, ignore_errors=True) + shutil.copytree(release_outdir, stable_dir) if __name__ == "__main__": From 18a76839d8cd4df47043d874a8e62ec37cf8439c Mon Sep 17 00:00:00 2001 From: Adrian D'Alessandro Date: Thu, 18 Jun 2026 15:37:10 +0100 Subject: [PATCH 6/6] Use ARIA semantics for live-updated banner Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- theme/header.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/theme/header.hbs b/theme/header.hbs index eadd25137..7063a5a77 100644 --- a/theme/header.hbs +++ b/theme/header.hbs @@ -15,7 +15,7 @@ } -
+