environments: hide legacy environments by default, add a changelog

New users don't need to know about them, since they are currently phased out. To give some context on when environments were added/removed add a changelog with some links for extra context. To enable the tabbed content feature enable the mkdocs plugin for it.
msys2 · Sep 22, 2024 · 5fe900f · 5fe900f
1 parent c9794f1
commit 5fe900f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 9 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -66,6 +66,8 @@ markdown_extensions:
     - codehilite
     - sane_lists
     - admonition
+    - pymdownx.tabbed:
+        alternate_style: true
     - pymdownx.arithmatex
     - pymdownx.betterem:
         smart_enable: all

diff --git a/web/docs/environments.md b/web/docs/environments.md
@@ -21,15 +21,22 @@ tools.
 
 ## Overview
 
-|                                                          | Name           | Prefix        | Toolchain | Architecture | C Library | C++ Library |
-|----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
-| ![msys](msys.png){: style="max-width:25px" }             | **MSYS**       | `/usr`        | gcc       | x86_64       | cygwin    | libstdc++   |
-| ![ucrt64](ucrt64.png){: style="max-width:25px" }         | **UCRT64**     | `/ucrt64`     | gcc       | x86_64       | ucrt      | libstdc++   |
-| ![clang64](clang64.png){: style="max-width:25px" }       | **CLANG64**    | `/clang64`    | llvm      | x86_64       | ucrt      | libc++      |
-| ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm      | aarch64      | ucrt      | libc++      |
-| ![clang32](clang32.png){: style="max-width:25px" }       | **CLANG32**    | `/clang32`    | llvm      | i686         | ucrt      | libc++      |
-| ![mingw64](mingw64.png){: style="max-width:25px" }       | **MINGW64**    | `/mingw64`    | gcc       | x86_64       | msvcrt    | libstdc++   |
-| ![mingw32](mingw32.png){: style="max-width:25px" }       | **MINGW32**    | `/mingw32`    | gcc       | i686         | msvcrt    | libstdc++   |
+=== "Environments"
+
+    |                                                          | Name           | Prefix        | Toolchain | Architecture | C Library | C++ Library |
+    |----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
+    | ![msys](msys.png){: style="max-width:25px" }             | **MSYS**       | `/usr`        | gcc       | x86_64       | cygwin    | libstdc++   |
+    | ![ucrt64](ucrt64.png){: style="max-width:25px" }         | **UCRT64**     | `/ucrt64`     | gcc       | x86_64       | ucrt      | libstdc++   |
+    | ![clang64](clang64.png){: style="max-width:25px" }       | **CLANG64**    | `/clang64`    | llvm      | x86_64       | ucrt      | libc++      |
+    | ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm      | aarch64      | ucrt      | libc++      |
+    | ![mingw64](mingw64.png){: style="max-width:25px" }       | **MINGW64**    | `/mingw64`    | gcc       | x86_64       | msvcrt    | libstdc++   |
+
+=== "Legacy Environments"
+
+    |                                                          | Name           | Prefix        | Toolchain | Architecture | C Library | C++ Library |
+    |----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
+    | ![clang32](clang32.png){: style="max-width:25px" }       | **CLANG32**    | `/clang32`    | llvm      | i686         | ucrt      | libc++      |
+    | ![mingw32](mingw32.png){: style="max-width:25px" }       | **MINGW32**    | `/mingw32`    | gcc       | i686         | msvcrt    | libstdc++   |
 
 The active environment is selected via the `MSYSTEM` environment variable.
 Setting `MSYSTEM` to `UCRT64` and starting a login shell will put you in that
@@ -87,3 +94,17 @@ code was compiled with MSVC.
   and Windows Server 2016 or later. For older Windows versions, you have to
   provide it explicitly or depend on the user having it installed. More
   information about that can be found in [UCRT deployment](https://learn.microsoft.com/en-us/cpp/windows/universal-crt-deployment).
+
+## Changelog
+
+**2023-12-13:** Start of phase out for 32-bit environments, MINGW32 and CLANG32. See [NEWS](../news.md#2023-12-13-starting-to-drop-some-32-bit-packages) for more information.
+
+**2022-12-30:** Added CLANGARM64 environment.
+
+**2022-10-29:** Changed the default environment from MINGW64 to UCRT64. See [NEWS](../news.md#2022-10-29-changing-the-default-environment-from-mingw64-to-ucrt64) for more information.
+
+**2022-05-01:** Added CLANG32 environment.
+
+**2021-03-26:** Added UCRT64 environment.
+
+**2020-05-17:** Dropped 32-bit variant of the MSYS environment. See [NEWS](../news.md#2020-05-17-32-bit-msys2-no-longer-actively-supported) for more information.