Skip to content

Adopt skainet-docs-ui v1.1.1 (#53)#54

Merged
michalharakal merged 1 commit intodevelopfrom
feature/53-skainet-docs-ui-v1
Apr 13, 2026
Merged

Adopt skainet-docs-ui v1.1.1 (#53)#54
michalharakal merged 1 commit intodevelopfrom
feature/53-skainet-docs-ui-v1

Conversation

@michalharakal
Copy link
Copy Markdown
Contributor

Closes #53.

Visual alignment with mainline SKaiNET. Bumps `docs/antora-playbook.yml`'s
`ui.bundle.url` to the new shared SKaiNET-branded Antora UI bundle from
`SKaiNET-developers/skainet-docs-ui`,
pinned to `v1.1.1`. Mainline SKaiNET pins the same bundle in
SKaiNET#502.

Two-line scope

```diff
ui:
bundle:

What you'll see in the rebuilt site

  • Brand color: SKaiNET red `#dc2626` instead of upstream Antora blue
  • Typography: Orbitron headings, Inter body, Fira Code monospace (was Roboto everywhere)
  • Dark mode toggle in the navbar (🌓 button), persists via `localStorage`, defaults from `prefers-color-scheme`, FOUC-safe via inline head bootstrap
  • Code blocks: GitHub-light `#f6f8fa` in light mode, GitHub-dark `#0d1117` in dark mode, 8px rounded corners, 1px border
  • Scrollbar: 6px thin
  • Focus glow: primary-red on `:focus-visible` for links / buttons / nav items
  • Footer: replaces upstream "Antora default UI / MPL-2.0" boilerplate with SKaiNET attribution + cross-repo links to mainline + skainet-docs-ui
  • Mobile: responsive hamburger nav (preserved from upstream)
  • `.card-grid` CSS: available but unused on this site (the existing Key Features / Supported Model Families landing content is preserved)

Compatibility notes

  • The new UI bundle does NOT touch asciidoctor extensions. The existing `asciidoctor-kroki` extension and `kroki-fetch-diagram: true` config in this playbook continue to work unchanged — mermaid rendering follows the same pipeline as before.
  • The bundle is content-neutral: nav entries, page content, and per-page metadata still come from this repo's modules and playbook. Only visual chrome (CSS, JS, partials) comes from the bundle.

Out of scope

  • Rewriting the landing page with a Diátaxis card-grid. The transformers landing has substantial real content (Key Features, Supported Model Families table) and shouldn't be replaced wholesale. A future PR can add a card-grid SECTION above or below the existing content if useful.
  • Self-hosted fonts. v1.1.1 still loads Orbitron / Inter / Fira Code from Google Fonts; can move to bundled `@font-face` files when skainet-docs-ui v1.2 ships.
  • Search wiring (`SITE_SEARCH_PROVIDER` env var still unset; the UI ships an input box already, just needs a search backend).

🤖 Generated with Claude Code

Bumps docs/antora-playbook.yml ui.bundle.url from upstream
gitlab.com/antora/antora-ui-default to the new shared SKaiNET-
branded bundle at:

    https://github.com/SKaiNET-developers/skainet-docs-ui/releases/download/v1.1.1/ui-bundle.zip

The new bundle is the shared SKaiNET docs UI from
https://github.com/SKaiNET-developers/skainet-docs-ui — same
URL mainline SKaiNET pins to as of SKaiNET#502.

## Visual changes

- SKaiNET red palette (#dc2626) replaces upstream Antora blue
- Orbitron (display) + Inter (body) + Fira Code (mono) replace Roboto
- Light + dark theme toggle in the navbar (FOUC-safe inline head
  bootstrap, persisted via localStorage, prefers-color-scheme fallback)
- 6px thin custom scrollbar
- Rounded code blocks with GitHub-light / GitHub-dark backgrounds
- Primary-red focus glow on interactive elements
- New SKaiNET footer with cross-repo links to mainline +
  skainet-docs-ui (replaces the upstream Antora default UI /
  MPL-2.0 boilerplate)
- .card-grid CSS available but unused on this site (the existing
  Key Features / Supported Model Families content stays
  untouched)
- Mobile responsive (hamburger menu from upstream preserved)

## Out of scope

- Rewriting the index.adoc landing with a Diátaxis card-grid. The
  transformers landing has substantial real content (Key Features
  table, Supported Model Families table) that shouldn't be
  replaced wholesale. A future PR can add a card-grid SECTION
  above or below the existing content.
- Self-hosted fonts. v1.1.1 still loads from Google Fonts; can
  move to bundled @font-face when skainet-docs-ui v1.2 ships.
- Search wiring.

Closes #53.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@michalharakal michalharakal merged commit fbeb932 into develop Apr 13, 2026
4 checks passed
@michalharakal michalharakal deleted the feature/53-skainet-docs-ui-v1 branch April 13, 2026 18:49
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.

Adopt skainet-docs-ui v1.1.1 (SKaiNET-branded Antora UI)

2 participants