Adopt skainet-docs-ui v1.1.1 + Diátaxis card-grid landing (#501)#502
Merged
michalharakal merged 1 commit intodevelopfrom Apr 13, 2026
Merged
Adopt skainet-docs-ui v1.1.1 + Diátaxis card-grid landing (#501)#502michalharakal merged 1 commit intodevelopfrom
michalharakal merged 1 commit intodevelopfrom
Conversation
Two coupled changes that swap mainline's Antora UI bundle for
the new SKaiNET-branded skainet-docs-ui release and rewrite
the landing page to use its card-grid component.
## docs/antora-playbook.yml
Pin ui.bundle.url to:
https://github.com/SKaiNET-developers/skainet-docs-ui/releases/download/v1.1.1/ui-bundle.zip
Replaces the upstream gitlab.com/antora/antora-ui-default URL
that mainline had been pinned to since the Antora migration in
#494/#495. The new bundle is the shared SKaiNET docs UI from
the new skainet-docs-ui repo (https://github.com/SKaiNET-developers/skainet-docs-ui)
which ships:
- SKaiNET red palette (#dc2626) with light + dark mode
- Orbitron (display) + Inter (body) + Fira Code (mono)
- Class-based dark mode toggle (FOUC-safe via inline head bootstrap)
- 6px thin custom scrollbar
- Rounded code blocks with GitHub-light / GitHub-dark
- Primary-red focus glow on links / buttons
- SKaiNET footer (replaces the upstream MPL-2.0 / antora-ui
boilerplate)
- .card-grid CSS for landing-page card grids
- Mobile responsive (hamburger menu from upstream preserved)
Pinned to v1.1.1 specifically (not floating on latest) so
mainline builds are reproducible. Bumping the pin is a one-line
follow-up PR whenever skainet-docs-ui ships a new minor.
## docs/modules/ROOT/pages/index.adoc
Replaces the placeholder "Quick links" section with a real
[.card-grid] block that surfaces the four Diátaxis sections
(Tutorials / How-to / Reference / Explanation) as clickable
cards with one-line descriptions. Each card links to the first
real page of its section:
Tutorials -> tutorials/java-getting-started.adoc
How-to -> how-to/build.adoc
Reference -> reference/architecture.adoc
(with inline xrefs to operator catalog +
ops-status-matrix + Dokka API)
Explanation -> explanation/skainet-for-ai.adoc
The [.card-grid] role is rendered into a responsive grid by
the new CSS in skainet-docs-ui's src/css/skainet-polish.css
(landed in v1.1.0). Falls back to a normal bulleted list on
any consumer that doesn't ship the SKaiNET CSS — never a
broken render.
The Diátaxis NOTE admonition pointing at SKaiNET-transformers
for LLM runtimes stays — that was added in the original
migration to make the repo split visible.
## Verification
Local Antora build against the published v1.1.1 bundle URL
(no --ui-bundle-url override):
docker run --rm --user "$(id -u):$(id -g)" \
-v "$PWD:/antora" -w /antora \
skainet-antora:local docs/antora-playbook.yml
- exit 0
- rendered index.html contains <div class="ulist card-grid">
with the four cards
- rendered footer contains the SKaiNET-attribution links to
skainet-docs-ui, mainline, and SKaiNET-transformers
- all other pages (tutorials, how-to, reference, explanation,
operator catalog, ops-status-matrix) render unchanged but
in the new red-on-dark/light theme
Closes #501.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
📖 Documentation Preview The documentation has been built successfully for this PR. Generated Files:
Artifacts:
This comment will be updated automatically when the PR is updated. |
This was referenced Apr 13, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #501.
Summary
Swap mainline's Antora UI bundle for the new SKaiNET-branded
`skainet-docs-ui`
release, pinned to `v1.1.1`, and rewrite the docs landing page
to use its `.card-grid` component for a real Diátaxis
four-card grid.
Two-line scope
```diff
ui:
bundle:
snapshot: true
```
```diff
```
What ships in the new bundle
The skainet-docs-ui repo is the shared Antora UI for every
SKaiNET docs site (mainline, SKaiNET-transformers, future
siblings). Forked from upstream antora-ui-default and
SKaiNET-ified across six commits:
Visual changes you'll see
Verification
Local docker build of the docs site against the published v1.1.1 bundle URL (no local override):
```bash
docker run --rm --user "$(id -u):$(id -g)" \
-v "$PWD:/antora" -w /antora \
skainet-antora:local docs/antora-playbook.yml
python3 -m http.server --directory docs/build/site 8080
```
Out of scope
Coordinated as a separate PR on that repo.
page load — fine for v1, can move to bundled @font-face files
in a UI v1.2).
UI ships an input box already, just needs a search backend).
🤖 Generated with Claude Code