Skip to content

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

Merged
sberyozkin merged 1 commit into
smallrye:mainfrom
phillip-kruger:docs-asciidoc
Oct 15, 2026
Merged

sberyozkin merged 1 commit into
smallrye:mainfrom
phillip-kruger:docs-asciidoc

Conversation

@phillip-kruger

Copy link
Copy Markdown
Member

The docs move from Antora to AsciiDoc, laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/smallrye-jwt// (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/*.adoc become docs/src/main/asciidoc/*.adoc, with the same names (so the same addresses).
    • The sidebar is in _nav.yml (from nav.adoc), and shared attributes are in _attributes.adoc.
    • Ids are Quarkus-style, e.g. #a-section.
  • The pages were written as a :doctype: book with an attributes.adoc include. They are now regular pages with one title each. The included file only set an unused :version: 2.1.2-SNAPSHOT, so it is gone. The cross-page <<generate-jwt-tokens>> reference is now an xref:.
  • 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: doc/ (antora.yml, the playbook).
  • Docs and README links. docs/README.adoc explains how to write and preview pages, and the README links point to the new location.

Old addresses

smallrye.io already publishes this project's current release from the Antora sources, converted on the fly. The old /docs/smallrye-jwt/...html addresses redirect to the new pages.

Checked

All 3 pages render with the smallrye.io site, with no errors or Asciidoctor warnings, and all internal links resolve.

…llrye.io

The docs are now AsciiDoc in docs/src/main/asciidoc, laid out like the Quarkus guides, and
smallrye.io pulls them in: the main branch nightly and each release once tagged, at
https://smallrye.io/docs/smallrye-jwt/<version>/. They are no longer built by Antora.

- One .adoc page per former Antora page, same names; the sidebar is _nav.yml and shared
  attributes are in _attributes.adoc.
- Section ids are Quarkus-style (like-this); old /docs/smallrye-jwt/... addresses on smallrye.io
  redirect to the new pages.
- Pull requests touching docs/ are rendered with the smallrye.io site by the new
  Documentation workflow.
- doc/ (antora.yml and the playbook) is removed.
@phillip-kruger
phillip-kruger requested a review from a team as a code owner October 15, 2026 01:12

@sberyozkin sberyozkin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks

@sberyozkin
sberyozkin merged commit 895d203 into smallrye:main Oct 15, 2026
7 checks passed
@github-actions github-actions Bot added this to the 5.0.0 milestone Oct 15, 2026
@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 Antora 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/smallrye-jwt/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
Generate JWT Tokens · old page
Generate JWT Tokens, beforeGenerate JWT Tokens, after
Generate JWT Tokens, with the Contents sidebar open
Generate JWT Tokens, 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
Generate JWT Tokens · old page
Generate JWT Tokens, before, dark themeGenerate JWT Tokens, after, dark theme
Generate JWT Tokens, with the Contents sidebar open
Generate JWT Tokens, sidebar open, dark theme

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