Skip to content

docs(antora): fix version-currency + broken links across all pages#758

Merged
michalharakal merged 1 commit into
developfrom
docs/antora-audit
Jun 24, 2026
Merged

docs(antora): fix version-currency + broken links across all pages#758
michalharakal merged 1 commit into
developfrom
docs/antora-audit

Conversation

@michalharakal

Copy link
Copy Markdown
Contributor

Audited every Antora page (50 .adoc across ROOT + skeep) for version-currency and link validity.

Version-currency

Bumped dependency snippets to the current release 0.32.1 (BOM + Maven version) in io-readers, minerva-export, image-data-getting-started, java-getting-started (×2), java-model-training. Left historical "introduced in 0.21/0.22" references intact.

Links

All xref:/image::/include:: targets already resolve (0 broken). Fixed broken link:/macros — mostly README-port artifacts:

  • .md link: → Antora xref: (java tutorials cross-links)
  • link:./OPTIMIZATION.md, link:./examples/hlo/ → GitHub blob/tree URLs
  • dead docs.skainet.sk/hlo/xref:reference/api.adoc
  • tensorflow.org/xla (moved) → openxla.org/xla
  • dead repo-root rfc.md → the tracking issue RFC: Hybrid adaptive DSL with optional dtype constraints — easy-wins implementation #615
  • dropped dead bench-prd.md PRD link; fixed ainet-sk/SKaiNETSKaiNET-developers/SKaiNET in the runner example

Flagged, not touched

The generated docs are stamped at old versions — ops-status-matrix + operators/generated/* (0.27.0) and kernel-support-matrix (0.31.2). They're marked "do not edit by hand"; refresh via ./gradlew generateOperatorDocs generateKernelMatrix once a build regenerates their source JSON (a release-pipeline step).

🤖 Generated with Claude Code

Audited every Antora page (50 .adoc) for version-currency and link validity.

Version-currency — dependency snippets bumped to the current release 0.32.1:
- skainet-bom: io-readers, minerva-export, image-data-getting-started, java-getting-started
- Maven version: java-getting-started (<skainet.version>), java-model-training (<version>)
- (Historical "introduced in 0.21/0.22" etc. left as-is.)

Links — all xref/image/include targets already resolve; fixed broken `link:`/macros:
- README-port `.md` link: -> Antora xref: (java-getting-started, java-model-training)
- hlo-getting-started: `link:./OPTIMIZATION.md` + `link:./examples/hlo/` -> GitHub URLs;
  dead `docs.skainet.sk/hlo/` -> xref:reference/api.adoc; tensorflow.org/xla -> openxla.org
- dtype-model: dead repo-root `rfc.md` refs -> the tracking issue #615
- benchmarks: dropped dead `bench-prd.md` PRD link (+ unused :url-prd:); fixed
  `ainet-sk/SKaiNET` -> `SKaiNET-developers/SKaiNET` in the runner-register example

Not touched (generated, "do not edit by hand"): ops-status-matrix / operators/generated
(stamped 0.27.0) and kernel-support-matrix (0.31.2) — these refresh via
`./gradlew generateOperatorDocs generateKernelMatrix` after a build regenerates their
source JSON; that's a release-pipeline step, flagged separately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📖 Documentation Preview

The documentation has been built successfully for this PR.

Generated Files:

  • Operator documentation: docs/modules/operators/_generated_/
  • JSON schema output: operators.json

Artifacts:

  • Download the documentation-preview-758 artifact to view the complete documentation locally.

This comment will be updated automatically when the PR is updated.

@michalharakal michalharakal merged commit 3840991 into develop Jun 24, 2026
7 checks passed
@michalharakal michalharakal deleted the docs/antora-audit branch June 25, 2026 13:50
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