Skip to content

Move the documentation from Antora to AsciiDoc pages published on smallrye.io - #733

Open
phillip-kruger wants to merge 1 commit into
smallrye:mainfrom
phillip-kruger:docs-asciidoc
Open

phillip-kruger wants to merge 1 commit into
smallrye:mainfrom
phillip-kruger:docs-asciidoc

Conversation

@phillip-kruger

Copy link
Copy Markdown
Member

The docs move from their own Antora site to AsciiDoc laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/jandex// (smallrye/smallrye.github.io#136): main nightly, each release once it is tagged.

Depends on smallrye/smallrye.github.io#136. The new Documentation check calls the reusable workflow added there.

What changes

  • Pages. doc/modules/ROOT/pages/** become docs/src/main/asciidoc/** with the same paths, so the pages keep their names (core/indexing, maven/basic, …).
    • nav.adoc becomes _nav.yml; shared attributes are in _attributes.adoc.
    • Pages in subdirectories set :version-root: so shared paths work from any depth.
  • PR check. Pull requests touching docs/ run the Documentation workflow. It renders the docs with the smallrye.io site, fails on a broken include or a page that does not render, and attaches the rendered site as an artifact.
  • Removed: the Antora component (doc/: antora.yml, playbooks), the Jandex GitHub Pages workflow, and the release job that ran it. The release no longer publishes docs; smallrye.io picks up the tag.
  • Docs and README links. docs/README.adoc explains how to write and preview pages, and the README links to the new location.

Old addresses

The current site at https://smallrye.io/jandex/ (gh-pages, docs/jandex/main/*.html) stays where it is for now. Its pages will separately be replaced by redirects to the same page under https://smallrye.io/docs/jandex/latest/.

Checked

  • The docs synced from this branch render with the smallrye.io site without errors or Asciidoctor warnings.
  • All 205 internal links resolve, anchors included.

@phillip-kruger
phillip-kruger requested a review from a team as a code owner October 15, 2026 01:11
@phillip-kruger

phillip-kruger commented Oct 15, 2026 •

Copy link
Copy Markdown
Member Author

Screenshots of the documentation before and after this change (updated).

Before: the MkDocs site, as it is on smallrye.io today. After: this branch's AsciiDoc, rendered by smallrye.io with smallrye/smallrye.github.io#136 (a local build: /docs/jandex/main/). On smallrye.io the sidebar starts closed (the ☰ button opens it, and it stays open on the next pages for that reader); its groups are folded except the one holding the current page. The project and version picker sit in the header next to the logo, so a start page has no separate title; further down, a start page lists the documentation, from its navigation.

BeforeAfter
Start page · old page
Start page, beforeStart page, after
Indexing Classes · old page
Indexing Classes, beforeIndexing Classes, after
Indexing Classes, with the Contents sidebar open
Indexing Classes, sidebar open
Dark theme: the same screenshots with the dark theme

The old Antora sites and the GraphQL, Vert.x bindings and Mutiny Zero MkDocs sites have no dark theme, so their "before" stays light; the other old MkDocs sites were switched to their own dark palette.

Before (dark theme)After (dark theme)
Start page · old page
Start page, before, dark themeStart page, after, dark theme
Indexing Classes · old page
Indexing Classes, before, dark themeIndexing Classes, after, dark theme
Indexing Classes, with the Contents sidebar open
Indexing Classes, sidebar open, dark theme

Comment thread docs/README.adoc Outdated
Ladicek
Ladicek previously approved these changes Oct 15, 2026

@Ladicek Ladicek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I'll wait with merging until smallrye/smallrye.github.io#136 is done, as advised there.

Ladicek
Ladicek previously approved these changes Oct 15, 2026

This branch has not been deployed

No deployments
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.

2 participants