Refine GitHub Pages presentation layout

.github/workflows/ci.yml

@@ -36,6 +36,9 @@ jobs:
           source: ./docs
           destination: ./build/pages
 
+      - name: Check generated GitHub Pages site
+        run: make generated-pages-check
+
   build-and-test:
     runs-on: ubuntu-latest
 

Makefile

@@ -3,6 +3,7 @@ AR ?= ar
 UV ?= uv
 PYTHON ?= python3
 VALGRIND ?= valgrind
+PAGES_BUILD_DIR ?= build/pages
 UV_CACHE_DIR ?= $(CURDIR)/.uv-cache
 export UV_CACHE_DIR
 
@@ -83,6 +84,7 @@ SHARED_LIBRARY := $(LIB_DIR)/libwang.so
 OPENMP_LIBRARY := $(LIB_DIR)/libwang_openmp.a
 
 .PHONY: all setup serial shared openmp check c-check python-check pages-check \
+	generated-pages-check \
 	strict-check sanitizer-check analyzer-check valgrind-check \
 	cachegrind-check benchmark benchmark-smoke benchmark-compare \
 	benchmark-compare-smoke coverage coverage-c coverage-python \
@@ -161,6 +163,9 @@ check: pages-check c-check openmp python-check benchmark-smoke benchmark-compare
 pages-check:
 	$(PYTHON) tools/check_pages.py
 
+generated-pages-check:
+	$(PYTHON) tools/check_generated_pages.py $(PAGES_BUILD_DIR)
+
 c-check: serial $(C_TEST_BINS)
 	@set -e; \
 	if [ -z "$(strip $(C_TEST_BINS))" ]; then \

docs/_includes/home-evidence.html

@@ -0,0 +1,30 @@
+{% assign evidence = include.evidence %}
+{% if evidence.eyebrow and evidence.title and evidence.items.size > 0 %}
+  <section
+    class="home-section home-visual layout-presentation"
+    id="{{ evidence.id | default: 'evidence' | escape }}"
+  >
+    <div class="section-heading">
+      <p class="eyebrow">{{ evidence.eyebrow | escape }}</p>
+      <h2>{{ evidence.title | escape }}</h2>
+    </div>
+
+    {% if evidence.introduction %}
+      <p class="home-section__prose">{{ evidence.introduction | escape }}</p>
+    {% endif %}
+
+    <ul class="evidence-band">
+      {% for item in evidence.items %}
+        <li>
+          {% if item.role %}
+            <span class="evidence-band__role">{{ item.role | escape }}</span>
+          {% endif %}
+          <strong>{{ item.label | escape }}</strong>
+          {% if item.detail %}
+            <span class="evidence-band__detail">{{ item.detail | escape }}</span>
+          {% endif %}
+        </li>
+      {% endfor %}
+    </ul>
+  </section>
+{% endif %}

docs/_includes/home-output.html

@@ -0,0 +1,33 @@
+{% assign output = include.output %}
+{% if output.eyebrow and output.title and output.image and output.alt and output.caption and output.width and output.height %}
+  <section
+    class="home-section home-visual layout-presentation"
+    id="{{ output.id | default: 'featured-output' | escape }}"
+  >
+    <div class="section-heading">
+      <p class="eyebrow">{{ output.eyebrow | escape }}</p>
+      <h2>{{ output.title | escape }}</h2>
+    </div>
+
+    <figure class="home-output">
+      <div class="home-output__media">
+        <img
+          src="{{ output.image | relative_url }}"
+          alt="{{ output.alt | escape }}"
+          width="{{ output.width }}"
+          height="{{ output.height }}"
+          loading="lazy"
+          decoding="async"
+        >
+      </div>
+      <figcaption>
+        <p>{{ output.caption | escape }}</p>
+        {% if output.source and output.source_label %}
+          <a class="text-link" href="{{ output.source | relative_url }}">
+            {{ output.source_label | escape }}
+          </a>
+        {% endif %}
+      </figcaption>
+    </figure>
+  </section>
+{% endif %}

docs/_includes/home-pipeline.html

@@ -0,0 +1,56 @@
+{% assign pipeline = include.pipeline %}
+{% if pipeline.eyebrow and pipeline.title and pipeline.stages.size > 0 %}
+  <section
+    class="home-section home-visual layout-presentation"
+    id="{{ pipeline.id | default: 'pipeline' | escape }}"
+  >
+    <div class="section-heading">
+      <p class="eyebrow">{{ pipeline.eyebrow | escape }}</p>
+      <h2>{{ pipeline.title | escape }}</h2>
+    </div>
+
+    {% if pipeline.introduction %}
+      <p class="home-section__prose">{{ pipeline.introduction | escape }}</p>
+    {% endif %}
+
+    <figure class="home-pipeline">
+      <ol
+        class="home-pipeline__track"
+        aria-label="{{ pipeline.track_label | default: pipeline.title | escape }}"
+      >
+        {% for stage in pipeline.stages %}
+          <li class="home-pipeline__stage">
+            <span class="home-pipeline__index" aria-hidden="true">{{ forloop.index }}</span>
+            <strong>{{ stage.label | escape }}</strong>
+            {% if stage.detail %}
+              <span class="home-pipeline__detail">{{ stage.detail | escape }}</span>
+            {% endif %}
+          </li>
+        {% endfor %}
+      </ol>
+
+      {% if pipeline.checks.size > 0 %}
+        <aside
+          class="home-pipeline__checks"
+          aria-label="{{ pipeline.checks_label | default: 'Independent checks' | escape }}"
+        >
+          <p>{{ pipeline.checks_label | default: 'Independent checks' | escape }}</p>
+          <ul>
+            {% for check in pipeline.checks %}
+              <li>
+                <strong>{{ check.label | escape }}</strong>
+                {% if check.detail %}
+                  <span class="home-pipeline__detail">{{ check.detail | escape }}</span>
+                {% endif %}
+              </li>
+            {% endfor %}
+          </ul>
+        </aside>
+      {% endif %}
+
+      {% if pipeline.caption %}
+        <figcaption>{{ pipeline.caption | escape }}</figcaption>
+      {% endif %}
+    </figure>
+  </section>
+{% endif %}

docs/_includes/home-status.html

@@ -0,0 +1,30 @@
+{% assign status = include.status %}
+{% if status.eyebrow and status.title and status.items.size > 0 %}
+  <section
+    class="home-section home-status layout-reading"
+    id="{{ status.id | default: 'implementation-status' | escape }}"
+  >
+    <div class="section-heading">
+      <p class="eyebrow">{{ status.eyebrow | escape }}</p>
+      <h2>{{ status.title | escape }}</h2>
+    </div>
+
+    {% if status.introduction %}
+      <p class="home-section__prose">{{ status.introduction | escape }}</p>
+    {% endif %}
+
+    <dl class="status-ledger">
+      {% for item in status.items %}
+        <div>
+          <dt>{{ item.label | escape }}</dt>
+          <dd>
+            <strong>{{ item.state | escape }}</strong>
+            {% if item.detail %}
+              <span class="status-ledger__detail">{{ item.detail | escape }}</span>
+            {% endif %}
+          </dd>
+        </div>
+      {% endfor %}
+    </dl>
+  </section>
+{% endif %}

docs/_layouts/default.html

@@ -7,7 +7,7 @@
     <meta name="theme-color" content="#070809">
 
     {% assign page_description = page.abstract | default: page.description | default: site.description %}
-    <title>{% if page.title %}{{ page.title | escape }} · {% endif %}{{ site.title | escape }}</title>
+    <title>{% if page.page_kind == 'home' %}{{ site.title | escape }}{% elsif page.title %}{{ page.title | escape }} · {{ site.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
     <meta name="description" content="{{ page_description | strip_html | normalize_whitespace | escape }}">
     <link rel="canonical" href="{{ page.url | absolute_url }}">
     <link rel="icon" href="{{ '/assets/images/tile-mark.svg' | relative_url }}" type="image/svg+xml">