Display the hierarchy of non-overlapping groups as a mindmap

changelog.md

@@ -5,6 +5,7 @@
 > [!IMPORTANT]
 > This version is not released yet and is under active development.
 
+- Display the hierarchy of non-overlapping groups as a mindmap.
 - Add URL on all platforms.
 - Add support for openSUSE Tumbleweed detection. Closes #133.
 - Do not allow icons on platforms and groups to be empty.

extra_platforms/docs_update.py

@@ -79,7 +79,11 @@ def generate_platform_sankey() -> str:
     output = dedent("""\
         ```mermaid
         ---
-        config: {"sankey": {"showValues": false, "width": 800, "height": 400}}
+        config:
+            sankey:
+                showValues: false
+                width: 800
+                height: 400
         ---
         sankey-beta\n
         """)
@@ -88,6 +92,29 @@ def generate_platform_sankey() -> str:
     return output
 
 
+def generate_platform_hierarchy() -> str:
+    """Produce a mindmap hierarchy to show the non-overlapping groups."""
+    group_map = ""
+    for group in sorted(NON_OVERLAPPING_GROUPS, key=attrgetter("id"), reverse=True):
+        group_map += f"){group.icon} {group.id.upper()}(\n"
+        for platform in group.platforms:
+            group_map += f"    ({platform.icon} {platform.id})\n"
+
+    output = dedent("""\
+        ```mermaid
+        ---
+        config:
+            mindmap:
+                padding: 5
+        ---
+        mindmap
+            ((Extra Platforms))
+        """)
+    output += indent(group_map, " " * 8)
+    output += "```"
+    return output
+
+
 def generate_platforms_graph(
     graph_id: str,
     description: str,
@@ -158,14 +185,23 @@ def update_docs() -> None:
     )
     assert frozenset(g for groups in all_groups for g in groups["groups"]) == ALL_GROUPS
 
-    # Update the platform diagrams in readme.
+    # Update the Sankey diagram mapping groups to platforms.
     replace_content(
         project_root.joinpath("readme.md"),
         "<!-- platform-sankey-start -->\n\n",
         "\n\n<!-- platform-sankey-end -->",
         generate_platform_sankey(),
     )
 
+    # Update diagram showing the hierarchy of non-overlapping groups.
+    replace_content(
+        project_root.joinpath("readme.md"),
+        "<!-- platform-hierarchy-start -->\n\n",
+        "\n\n<!-- platform-hierarchy-end -->",
+        generate_platform_hierarchy(),
+    )
+
+    # Update grouping charts of all groups, including non-overlapping and extra groups.
     platform_doc = project_root.joinpath("readme.md")
     for top_groups in all_groups:
         replace_content(

readme.md

@@ -148,7 +148,11 @@ Relationships between groups and platforms:
 
 ```mermaid
 ---
-config: {"sankey": {"showValues": false, "width": 800, "height": 400}}
+config:
+    sankey:
+        showValues: false
+        width: 800
+        height: 400
 ---
 sankey-beta
 
@@ -376,6 +380,72 @@ any_windows,windows,1
 
 Each platform is assigned to a group of non-overlpaping families:
 
+<!-- platform-hierarchy-start -->
+
+```mermaid
+---
+config:
+    mindmap:
+        padding: 5
+---
+mindmap
+    ((Extra Platforms))
+        )≛ UNIX_LAYERS(
+            (Ͼ cygwin)
+        )Ⅴ SYSTEM_V(
+            (➿ aix)
+            (🌞 solaris)
+        )⊎ OTHER_UNIX(
+            (🐃 hurd)
+        )≚ LINUX_LAYERS(
+            (⊞ wsl1)
+            (⊞ wsl2)
+        )🐧 LINUX(
+            (🐧 altlinux)
+            (🙂 amzn)
+            (🤖 android)
+            (🎗️ arch)
+            (⛑️ buildroot)
+            (💠 centos)
+            (꩜ cloudlinux)
+            (🌀 debian)
+            (🐽 exherbo)
+            (🎩 fedora)
+            (🗜️ gentoo)
+            (🐃 guix)
+            (🤹 ibm_powerkvm)
+            (🤹 kvmibm)
+            (🌿 linuxmint)
+            (⍥ mageia)
+            (💫 mandriva)
+            (🦎 opensuse)
+            (🦴 oracle)
+            (∥ parallels)
+            (🍓 pidora)
+            (🍓 raspbian)
+            (🎩 rhel)
+            (⛰️ rocky)
+            (⚛️ scientific)
+            (🚬 slackware)
+            (🦎 sles)
+            (↻ tumbleweed)
+            (🤵 tuxedo)
+            (🎯 ubuntu)
+            (🐧 unknown_linux)
+            (Ⓧ xenserver)
+        )🅱️+ BSD(
+            (😈 freebsd)
+            (🍎 macos)
+            (🌘 midnightbsd)
+            (🚩 netbsd)
+            (🐡 openbsd)
+            (☀️ sunos)
+        )🪟 ANY_WINDOWS(
+            (🪟 windows)
+```
+
+<!-- platform-hierarchy-end -->
+
 <!-- NON_OVERLAPPING_GROUPS-graph-start -->
 
 ```mermaid