#!/usr/bin/env python3
"""The single definition of this site's nav and footer, and the tool that applies it.
Run from anywhere: python3 admin/build/chrome.py
Every page is hand-written static HTML — that stays true, because a human should be
able to open any file and edit it. What is NOT hand-maintained is the chrome: the nav
row (including the version badge that validate.js requires to agree everywhere) and the
footer columns. Those are defined once here and rewritten in place across the tree,
which is what stops a hundred-page site from drifting.
Adding a page: add it to NAV or FOOTER if it belongs there, write the file with any
nav/footer block at all, then run this. The block contents are replaced; the `here`
state is set from the page's own path.
Same tool, same rules, as pki.sgit.ai and graphs.sgit.ai.
"""
import re
import sys
from pathlib import Path
ROOT = Path(__file__).resolve().parents[2]
VERSION = (ROOT / "admin/build/version.txt").read_text().strip()
GH = "https://github.com/SGit-AI/SGit-AI__Website__Wardley-Maps"
PARENT = "https://sgit.ai"
PARENT_TITLE = ("sgit.ai — the parent project: the vault layer, the shipped CLI, and the "
"Strategy Maps vault this site's map inventory draws on")
# The nav, two levels. Each entry is (label, own page, [(sub-label, href), ...], prefixes).
#
# Two rules the structure has to keep, inherited from the house component:
# · A group label is always a link to a real page, never a menu-only stub. Nothing on
# this site should be reachable only by opening a dropdown.
# · `prefixes` decides the "here" state, so a page that is not itself in the nav — and
# on this site that is most of them, since /resources/ alone is 45 pages — still
# lights up the group it belongs to.
NAV = [
("Learn", "start/index.html", [
("Start here", "start/index.html"),
("The map gallery", "maps/index.html"),
("Glossary", "glossary/index.html"),
], ("start/", "glossary/", "maps/")),
("Method", "method/index.html", [
("The four claims", "method/index.html"),
("De-commoditisation", "method/de-commoditisation.html"),
("The custom-axis verdict", "method/custom-axes.html"),
("The broken middle", "method/broken-middle.html"),
("Maps are graphs with position", "method/maps-as-graphs.html"),
], ("method/",)),
("Doctrine", "doctrine/index.html", [
("The 40-record assessment", "doctrine/index.html"),
("Explorer / Villager / Town Planner", "patterns/pst/index.html"),
], ("doctrine/", "patterns/")),
("Resources", "resources/index.html", [
("All 34, verified", "resources/index.html"),
("Dead or dying", "resources/dead/index.html"),
("Link verification", "resources/verification.html"),
("Dinis Cruz on mapping, 2018–2025", "dinis/index.html"),
], ("resources/", "dinis/")),
("For agents", "agents/index.html", [
("The machine surface", "agents/index.html"),
("What ships, and what doesn't", "shipped/index.html"),
("The network", "network/index.html"),
], ("agents/", "shipped/", "network/")),
("Site", "admin/comms.html", [
("Comms: tasks & requests", "admin/comms.html"),
("Release history", "admin/versions.html"),
("Admin & engineering", "admin/index.html"),
("The documents", "documents/index.html"),
("Licensing", "about/licensing.html"),
("Where we lose", "about/participant.html"),
], ("admin/", "about/", "documents/")),
]
FOOTER = [
("Start", [
("→ Start here", "start/index.html"),
("The map gallery", "maps/index.html"),
("Glossary", "glossary/index.html"),
("What ships, and what doesn't", "shipped/index.html"),
]),
("The four claims", [
("De-commoditisation", "method/de-commoditisation.html"),
("The custom-axis verdict", "method/custom-axes.html"),
("The broken middle", "method/broken-middle.html"),
("Maps are graphs with position", "method/maps-as-graphs.html"),
("Explorer / Villager / Town Planner", "patterns/pst/index.html"),
]),
("The record", [
("The doctrine assessment", "doctrine/index.html"),
("34 resources, verified", "resources/index.html"),
("Dead or dying", "resources/dead/index.html"),
("Dinis Cruz, 2018–2025", "dinis/index.html"),
("The documents", "documents/index.html"),
]),
("Site", [
("Comms: tasks & requests", "admin/comms.html"),
("Release history", "admin/versions.html"),
("Licensing", "about/licensing.html"),
("llms.txt", "llms.txt"),
("llms-full.txt", "llms-full.txt"),
]),
]
BLURB = ("Wardley Mapping as a research site: the technique, an original doctrine assessment, "
"34 industry resources verified rather than listed, and the mapping thinking behind "
"the sgit.ai "
"network. This site's own content is CC BY 4.0; the ecosystem it quotes is CC BY-SA — "
"the difference "
"matters.")
WARDLEY = ('Wardley Mapping is provided courtesy of Simon Wardley, CC BY-SA 4.0. His blog, '
''
'blog.gardeviance.org, is CC BY-SA 3.0 — a different licence, quoted '
'under a separate notice. Nothing here is an adaptation of either.')
PARTNOTE = ('⚠ Participant disclosure: published by the sgit project, which uses the mapping '
'practice this site documents and is assessed by the doctrine page it hosts. '
''
'Read the disclosure.')
PARTNOTE_SELF = '⚠ Participant disclosure: published by the sgit project. You are on the disclosure page.'
NETLINE = ('↗ sgit.ai — the parent project and the Strategy '
'Maps vault · ↗ graphs.sgit.ai — '
'maps as graphs · ↗ pki.sgit.ai — where the doctrine '
'assessment was built · ↗ the network')
def nav_html(rel, up):
groups = []
for label, own, subs, prefixes in NAV:
active = rel == own or any(rel.startswith(pre) for pre in prefixes)
links = "\n".join(
f' {text}'
for text, href in subs)
groups.append(
f'
"
for head, links in FOOTER)
return (f'')
ICON = ('\n'
'')
def ensure_icon(text, up):
"""The favicon is chrome too. Injected here rather than written into every page for
the same reason the nav is: 69 pages, one definition, and no page can be missed."""
if 'rel="icon"' in text:
return re.sub(r']*>\n]*>',
lambda _: ICON.format(up=up), text, count=1)
return text.replace(f'',
ICON.format(up=up) + f'\n',
1)
def stamp_text_twins():
"""The version also appears in llms.txt, llms-full.txt and index.md, and validate.js
enforces that they agree. Nothing used to SET it there on the sibling sites, so it
was hand-edited every release — and hand-editing it silently missed twice. Own it
here instead."""
out = []
for name, pattern, repl in (
("llms.txt", r"Site version: v\d+\.\d+\.\d+", f"Site version: {VERSION}"),
("llms-full.txt", r"Site version: v\d+\.\d+\.\d+", f"Site version: {VERSION}"),
("index.md", r"· site v\d+\.\d+\.\d+ ·", f"· site {VERSION} ·"),
):
f = ROOT / name
if not f.exists():
continue
t = f.read_text()
t2, n = re.subn(pattern, repl, t, count=1)
if n and t2 != t:
f.write_text(t2)
out.append(name)
return out
def main():
changed, missing = [], []
skip = {".git", ".github", "node_modules", ".sg_vault"}
for path in sorted(ROOT.rglob("*.html")):
if skip & set(path.parts):
continue
rel = path.relative_to(ROOT).as_posix()
up = "../" * (len(path.relative_to(ROOT).parts) - 1)
text = before = path.read_text()
text = ensure_icon(text, up)
text, n_nav = re.subn(r'', lambda _: nav_html(rel, up),
text, count=1, flags=re.S)
text, n_foot = re.subn(r'', lambda _: footer_html(rel, up),
text, count=1, flags=re.S)
if not n_nav or not n_foot:
missing.append(f"{rel}: missing {'nav' if not n_nav else ''}"
f"{' and ' if not n_nav and not n_foot else ''}{'footer' if not n_foot else ''}")
if text != before:
path.write_text(text)
changed.append(rel)
changed += stamp_text_twins()
for m in missing:
print(f" ! {m}", file=sys.stderr)
print(f"chrome: {VERSION} applied — {len(changed)} file(s) updated"
+ (f", {len(missing)} without a chrome block" if missing else ""))
if __name__ == "__main__":
try:
main()
except BrokenPipeError:
sys.stdout = None