Skip to content

docs: render icons, repair the companion-adapter card, adopt the house theme - #8

Merged
SOSOVSKI merged 2 commits into
mainfrom
docs/icons-and-mechdsl-card
Sep 10, 2026
Merged

docs: render icons, repair the companion-adapter card, adopt the house theme#8
SOSOVSKI merged 2 commits into
mainfrom
docs/icons-and-mechdsl-card

Conversation

@SOSOVSKI

@SOSOVSKI SOSOVSKI commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Three corrections to the published documentation surface.

Icons were printing their own names

The homepage cards use Material's icon shorthand (:material-graph:,
:material-memory:), but pymdownx.emoji was never enabled, so nothing
resolved them and the live site showed the literal text.

The companion-adapter card was structurally broken

docs/index.md had an orphaned card body with --- and a description with
no icon or title line

The house theme

Ports the look from dev/demos/02-adaptive-path.html onto Material as
docs/stylesheets/akms.css (without the Baloo2 font for code and body)

Site URL

site_url was an empty string and repo_url/edit_uri were absent, all
marked "finalized at publication time" : leftover from the private to public transition

SOSOVSKI and others added 2 commits September 10, 2026 14:03
The homepage cards are written with Material's icon shorthand
(`:material-graph:`, `:material-memory:` and so on), but `pymdownx.emoji` was
never enabled, so nothing resolved them and the published site showed the
literal text.

Enabling it with Material's twemoji index and SVG generator is the documented
requirement for `.icons` shorthand.

Verified against a strict build: `:material-` appears zero times in the built
index.html, and four inline SVG icons render in the card grid.

Four, not five — the compmech-reference-pack card lost its icon and title line
when the package was dropped from the public tree, leaving an orphaned body.
That is a separate fix.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TcdE6eeSDBh8xrgKCoGrkw
…he site URL

Three corrections to the published documentation surface.

**The house theme.** Ports the look from dev/demos/02-adaptive-path.html onto
Material as docs/stylesheets/akms.css: the light and dark palettes, the 16/20px
radii, the 2.5px card borders and the hard offset shadows. The demo scopes its
tokens to [data-theme]; Material stamps [data-md-color-scheme], so the palettes
are re-scoped and mapped onto Material's own --md-* variables rather than
restated as a parallel system. `primary`/`accent` move to `custom` so the
stylesheet wins — a named Material colour would override it.

Typography is deliberately not a literal port. The demo sets a cursive face for
body and monospace text, which costs too much on reference tables, API
signatures and code blocks. Baloo 2 carries the identity on headings and the
header rule; body and code keep Material's readable defaults.

**The companion-adapter card.** docs/index.md carried an orphaned card body —
a `---` and a description with no icon or title line — left behind when
compmech-reference-pack was dropped from the public tree. It rendered as a
detached paragraph inside the grid. Restored as a proper card pointing at the
architecture page that documents extension points, worded so it describes the
adapter without implying it is installable yet.

**The site URL.** site_url was an empty string and repo_url/edit_uri were absent,
all three marked "finalized at publication time". They are knowable now, and
site_url drives canonical links and the sitemap.

Verified on a strict build: five cards render inline SVG icons, zero literal
`:material-` remains, the stylesheet is linked and emitted, and the canonical
link resolves to https://cemm2.github.io/AKMS/index.html.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TcdE6eeSDBh8xrgKCoGrkw
@SOSOVSKI
SOSOVSKI merged commit 7a089f6 into main Sep 10, 2026
13 checks passed
@SOSOVSKI
SOSOVSKI deleted the docs/icons-and-mechdsl-card branch September 10, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant